From 11dfa6edf1ac29bf25e93c14a1eec324b6e3e8f3 Mon Sep 17 00:00:00 2001 From: Kevin Leyow Date: Mon, 9 Sep 2024 15:39:28 -0500 Subject: [PATCH] feat(csi-101): add iso20022 flavour of api (#174) * feat(csi-101): add iso20022 flavour of api * chore: deps * chore: deps * chore: deps * chore: export * chore: formatting * chore: formatting * chore: minor regex change * chore: minor regex fix * chore: add in copilot examples for now * chore: deps * chore: title and version --- .ncurc.js | 4 +- audit-ci.jsonc | 3 +- ...-rest-v2.0-ISO20022-openapi3-snippets.yaml | 4735 + docs/index.html | 1 + .../components/headers/Content-Length.yaml | 9 + .../components/headers/Content-Type.yaml | 6 + .../components/parameters/Accept.yaml | 8 + .../components/parameters/Content-Length.yaml | 11 + .../components/parameters/Content-Type.yaml | 8 + .../openapi3/components/parameters/Date.yaml | 6 + .../parameters/FSPIOP-Destination.yaml | 13 + .../parameters/FSPIOP-Encryption.yaml | 8 + .../parameters/FSPIOP-HTTP-Method.yaml | 11 + .../parameters/FSPIOP-Signature.yaml | 8 + .../components/parameters/FSPIOP-Source.yaml | 10 + .../components/parameters/FSPIOP-URI.yaml | 10 + .../openapi3/components/parameters/ID.yaml | 6 + .../openapi3/components/parameters/SubId.yaml | 8 + .../openapi3/components/parameters/Type.yaml | 6 + .../parameters/X-Forwarded-For.yaml | 15 + .../openapi3/components/responses/200.yaml | 1 + .../openapi3/components/responses/202.yaml | 1 + .../openapi3/components/responses/400.yaml | 10 + .../openapi3/components/responses/401.yaml | 10 + .../openapi3/components/responses/403.yaml | 10 + .../openapi3/components/responses/404.yaml | 10 + .../openapi3/components/responses/405.yaml | 10 + .../openapi3/components/responses/406.yaml | 10 + .../openapi3/components/responses/501.yaml | 10 + .../openapi3/components/responses/503.yaml | 10 + .../schemas/AccountIdentification4Choice.yaml | 17 + .../schemas/AccountSchemeName1Choice.yaml | 16 + .../schemas/ActiveCurrencyAndAmount.yaml | 16 + .../ActiveCurrencyAndAmount_SimpleType.yaml | 13 + .../schemas/ActiveCurrencyCode.yaml | 8 + .../ActiveOrHistoricCurrencyAndAmount.yaml | 16 + ...rHistoricCurrencyAndAmount_SimpleType.yaml | 4 + .../schemas/ActiveOrHistoricCurrencyCode.yaml | 8 + .../components/schemas/AddressType2Code.yaml | 12 + .../schemas/AddressType3Choice.yaml | 16 + .../schemas/AnyBICDec2014Identifier.yaml | 12 + .../schemas/BICFIDec2014Identifier.yaml | 10 + .../components/schemas/BaseOneRate.yaml | 6 + ...ndFinancialInstitutionIdentification6.yaml | 29 + ...ndFinancialInstitutionIdentification8.yaml | 24 + .../components/schemas/BranchData3.yaml | 28 + .../components/schemas/BranchData5.yaml | 23 + .../components/schemas/CashAccount40.yaml | 24 + .../schemas/CashAccountType2Choice.yaml | 16 + .../schemas/CategoryPurpose1Choice.yaml | 17 + .../schemas/ChargeBearerType1Code.yaml | 23 + .../components/schemas/ChargeType3Choice.yaml | 15 + .../components/schemas/Charges16.yaml | 25 + .../schemas/ClearingChannel2Code.yaml | 22 + .../ClearingSystemIdentification2Choice.yaml | 16 + .../ClearingSystemMemberIdentification2.yaml | 16 + .../components/schemas/Contact13.yaml | 39 + .../openapi3/components/schemas/Contact4.yaml | 36 + .../components/schemas/CountryCode.yaml | 4 + .../schemas/CreditTransferTransaction67.yaml | 125 + .../schemas/CreditTransferTransaction68.yaml | 69 + .../schemas/CryptographicLockChoice.yaml | 16 + .../schemas/DateAndPlaceOfBirth1.yaml | 22 + .../components/schemas/DatePeriod2.yaml | 15 + .../components/schemas/ErrorCode.yaml | 11 + .../components/schemas/ErrorDescription.yaml | 5 + .../components/schemas/ErrorInformation.yaml | 13 + .../schemas/ErrorInformationResponse.yaml | 8 + .../schemas/Exact32HexBinaryText.yaml | 6 + .../schemas/Exact4AlphaNumericText.yaml | 6 + ...ecute_FIToFICustomerCreditTransferV13.yaml | 61 + .../components/schemas/Extension.yaml | 11 + .../components/schemas/ExtensionKey.yaml | 5 + .../components/schemas/ExtensionList.yaml | 15 + .../components/schemas/ExtensionValue.yaml | 5 + .../ExternalAccountIdentification1Code.yaml | 8 + .../schemas/ExternalCashAccountType1Code.yaml | 8 + .../schemas/ExternalCategoryPurpose1Code.yaml | 9 + .../schemas/ExternalChargeType1Code.yaml | 5 + ...rnalClearingSystemIdentification1Code.yaml | 5 + ...ExternalCreditorAgentInstruction1Code.yaml | 5 + ...nancialInstitutionIdentification1Code.yaml | 5 + .../schemas/ExternalLocalInstrument1Code.yaml | 5 + ...ternalOrganisationIdentification1Code.yaml | 5 + ...ExternalPaymentTransactionStatus1Code.yaml | 5 + .../ExternalPersonIdentification1Code.yaml | 5 + .../ExternalProxyAccountType1Code.yaml | 5 + .../schemas/ExternalPurpose1Code.yaml | 5 + .../schemas/ExternalServiceLevel1Code.yaml | 5 + .../schemas/ExternalStatusReason1Code.yaml | 5 + .../ExternalVerificationReason1Code.yaml | 5 + ...ancialIdentificationSchemeName1Choice.yaml | 14 + .../FinancialInstitutionIdentification18.yaml | 24 + .../FinancialInstitutionIdentification23.yaml | 24 + .../FxRequest_FICreditTransferProposal.yaml | 83 + ...Response_FICreditTransferConfirmation.yaml | 81 + ...FinancialInstitutionCreditTransferV12.yaml | 57 + .../GenericAccountIdentification1.yaml | 16 + .../GenericFinancialIdentification1.yaml | 16 + .../schemas/GenericIdentification3.yaml | 12 + .../schemas/GenericIdentification30.yaml | 16 + .../GenericOrganisationIdentification1.yaml | 16 + .../GenericOrganisationIdentification3.yaml | 16 + .../schemas/GenericPersonIdentification1.yaml | 16 + .../schemas/GenericPersonIdentification2.yaml | 16 + ...r_IdentificationVerificationReportV03.yaml | 57 + ...s_IdentificationVerificationReportV03.yaml | 57 + .../components/schemas/GroupHeader113.yaml | 72 + .../components/schemas/GroupHeader120.yaml | 35 + .../components/schemas/GroupHeader129.yaml | 58 + .../schemas/IBAN2007Identifier.yaml | 12 + .../openapi3/components/schemas/ISODate.yaml | 9 + .../components/schemas/ISODateTime.yaml | 21 + .../openapi3/components/schemas/ISOYear.yaml | 6 + .../schemas/IdentificationAssignment3.yaml | 33 + .../schemas/IdentificationInformation4.yaml | 22 + .../IdentificationVerificationIndicator.yaml | 3 + .../components/schemas/Instruction4Code.yaml | 14 + .../schemas/InstructionForCreditorAgent3.yaml | 13 + .../schemas/InstructionForNextAgent1.yaml | 13 + .../components/schemas/LEIIdentifier.yaml | 8 + .../schemas/LocalInstrument2Choice.yaml | 14 + .../components/schemas/Max105Text.yaml | 7 + .../components/schemas/Max10Text.yaml | 7 + .../components/schemas/Max128Text.yaml | 7 + .../components/schemas/Max140Text.yaml | 7 + .../components/schemas/Max15NumericText.yaml | 6 + .../components/schemas/Max16Text.yaml | 7 + .../components/schemas/Max2048Text.yaml | 7 + .../components/schemas/Max256Text.yaml | 7 + .../components/schemas/Max34Text.yaml | 7 + .../components/schemas/Max350Text.yaml | 7 + .../components/schemas/Max35Text.yaml | 7 + .../openapi3/components/schemas/Max4Text.yaml | 7 + .../components/schemas/Max70Text.yaml | 7 + .../components/schemas/NamePrefix2Code.yaml | 10 + .../openapi3/components/schemas/Number.yaml | 4 + .../schemas/OrganisationIdentification29.yaml | 19 + .../schemas/OrganisationIdentification39.yaml | 19 + ...sationIdentificationSchemeName1Choice.yaml | 16 + .../components/schemas/OtherContact1.yaml | 14 + ...acsError_FIToFIPaymentStatusReportV15.yaml | 35 + ...csStatus_FIToFIPaymentStatusReportV15.yaml | 79 + .../components/schemas/Party38Choice.yaml | 21 + .../components/schemas/Party40Choice.yaml | 37 + .../components/schemas/Party52Choice.yaml | 21 + .../schemas/PartyIdentification135.yaml | 34 + .../schemas/PartyIdentification272.yaml | 42 + .../schemas/PaymentIdentification13.yaml | 23 + .../schemas/PaymentTransaction163.yaml | 47 + .../schemas/PaymentTypeInformation28.yaml | 24 + .../components/schemas/PercentageRate.yaml | 4 + .../schemas/PersonIdentification13.yaml | 18 + .../schemas/PersonIdentification18.yaml | 18 + ...PersonIdentificationSchemeName1Choice.yaml | 16 + .../components/schemas/PhoneNumber.yaml | 5 + .../components/schemas/PostalAddress24.yaml | 55 + .../components/schemas/PostalAddress27.yaml | 61 + .../schemas/PreferredContactMethod1Code.yaml | 11 + .../schemas/PreferredContactMethod2Code.yaml | 11 + .../components/schemas/Priority2Code.yaml | 9 + .../schemas/ProxyAccountIdentification1.yaml | 15 + .../schemas/ProxyAccountType1Choice.yaml | 16 + .../components/schemas/Purpose2Choice.yaml | 21 + .../schemas/RegulatoryAuthority2.yaml | 12 + .../schemas/RegulatoryReporting3.yaml | 19 + .../schemas/RegulatoryReportingType1Code.yaml | 10 + .../schemas/ServiceLevel8Choice.yaml | 16 + .../schemas/SettlementInstruction15.yaml | 40 + .../schemas/SettlementMethod1Code.yaml | 10 + .../schemas/StatusReason6Choice.yaml | 16 + .../schemas/StatusReasonInformation14.yaml | 27 + .../StructuredRegulatoryReporting3.yaml | 26 + .../schemas/SupplementaryData1.yaml | 17 + .../schemas/SupplementaryDataEnvelope1.yaml | 5 + .../components/schemas/TaxAmount3.yaml | 29 + .../components/schemas/TaxAuthorisation1.yaml | 12 + .../openapi3/components/schemas/TaxData1.yaml | 57 + .../components/schemas/TaxParty1.yaml | 15 + .../components/schemas/TaxParty2.yaml | 20 + .../components/schemas/TaxPeriod3.yaml | 17 + .../components/schemas/TaxRecord3.yaml | 38 + .../components/schemas/TaxRecordDetails3.yaml | 21 + .../schemas/TaxRecordPeriod1Code.yaml | 43 + ...sRequest_FIToFICustomerCreditProposal.yaml | 25 + ...onse_FIToFICustomerCreditConfirmation.yaml | 28 + .../components/schemas/UUIDv4Identifier.yaml | 4 + .../schemas/VerificationReason1Choice.yaml | 14 + .../schemas/VerificationReport4.yaml | 29 + .../components/schemas/hexBinary.yaml | 4 + fspiop/v2_0_ISO20022/openapi3/openapi.yaml | 53 + .../openapi3/paths/fxQuotes.yaml | 46 + .../openapi3/paths/fxQuotes_{ID}.yaml | 81 + .../openapi3/paths/fxQuotes_{ID}_error.yaml | 49 + .../openapi3/paths/fxTransfers.yaml | 47 + .../openapi3/paths/fxTransfers_{ID}.yaml | 120 + .../paths/fxTransfers_{ID}_error.yaml | 49 + .../openapi3/paths/parties_{Type}_{ID}.yaml | 82 + .../paths/parties_{Type}_{ID}_error.yaml | 50 + .../paths/parties_{Type}_{ID}_{SubId}.yaml | 83 + .../parties_{Type}_{ID}_{SubId}_error.yaml | 51 + .../v2_0_ISO20022/openapi3/paths/quotes.yaml | 46 + .../openapi3/paths/quotes_{ID}.yaml | 80 + .../openapi3/paths/quotes_{ID}_error.yaml | 49 + .../openapi3/paths/transfers.yaml | 46 + .../openapi3/paths/transfers_{ID}.yaml | 119 + .../openapi3/paths/transfers_{ID}_error.yaml | 49 + package-lock.json | 8423 +- package.json | 50 +- src/fspiop/v1_0/openapi.ts | 8456 +- src/fspiop/v1_1/openapi.ts | 7431 +- src/fspiop/v2_0/openapi.ts | 9292 +- src/fspiop/v2_0/schemas.ts | 3 +- src/fspiop/v2_0/types.ts | 3 +- src/fspiop/v2_0_ISO20022/index.ts | 5 + src/fspiop/v2_0_ISO20022/json-schemas.json | 107991 +++++++++++++++ src/fspiop/v2_0_ISO20022/openapi.ts | 5163 + src/fspiop/v2_0_ISO20022/schemas.ts | 168 + src/fspiop/v2_0_ISO20022/types.ts | 168 + src/index.ts | 3 + .../v2_0_0/backend/openapi.ts | 2719 +- .../v2_0_0/outbound/openapi.ts | 3607 +- .../v2_1_0/backend/openapi.ts | 3253 +- .../v2_1_0/outbound/openapi.ts | 4251 +- src/thirdparty/openapi.ts | 8120 +- 225 files changed, 151213 insertions(+), 27158 deletions(-) create mode 100644 docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/openapi.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml create mode 100644 fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml create mode 100644 src/fspiop/v2_0_ISO20022/index.ts create mode 100644 src/fspiop/v2_0_ISO20022/json-schemas.json create mode 100644 src/fspiop/v2_0_ISO20022/openapi.ts create mode 100644 src/fspiop/v2_0_ISO20022/schemas.ts create mode 100644 src/fspiop/v2_0_ISO20022/types.ts diff --git a/.ncurc.js b/.ncurc.js index 4f7c6503..9300252d 100644 --- a/.ncurc.js +++ b/.ncurc.js @@ -7,6 +7,8 @@ module.exports = { '@redocly/cli', '@redocly/openapi-core', // Updating eslint breaks the build - 'eslint' + 'eslint', + // Breaks peer dependencies with v7+ + 'eslint-plugin-promise', ] } diff --git a/audit-ci.jsonc b/audit-ci.jsonc index 17b00d6d..7a02194d 100644 --- a/audit-ci.jsonc +++ b/audit-ci.jsonc @@ -4,6 +4,7 @@ // Only use one of ["low": true, "moderate": true, "high": true, "critical": true] "moderate": true, "allowlist": [ - "GHSA-wf5p-g6vw-rhxx" // https://github.com/advisories/GHSA-wf5p-g6vw-rhxx + "GHSA-wf5p-g6vw-rhxx", // https://github.com/advisories/GHSA-wf5p-g6vw-rhxx + "GHSA-3h5v-q93c-6h6q" // https://github.com/advisories/GHSA-3h5v-q93c-6h6q ] } diff --git a/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml new file mode 100644 index 00000000..79a08647 --- /dev/null +++ b/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml @@ -0,0 +1,4735 @@ +openapi: 3.0.2 +info: + version: v2.0-iso20022-draft + title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version + description: IN PROGRESS + license: + name: CC BY-ND 4.0 + url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md + contact: + name: Sam Kummary + url: https://github.com/mojaloop/mojaloop-specification/issues +servers: + - url: protocol://hostname:/switch/ + variables: + protocol: + enum: + - http + - https + default: https +paths: + /parties/{Type}/{ID}: + parameters: + - $ref: "#/components/parameters/Type" + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + get: + description: >- + The HTTP request `GET /parties/{Type}/{ID}` (or `GET + /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding + the requested Party, defined by `{Type}`, `{ID}` and optionally + `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET + /parties/BUSINESS/shoecompany/employee1`). + summary: Look up party information + tags: + - parties + operationId: PartiesByTypeAndID + parameters: + - $ref: "#/components/parameters/Accept" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + put: + description: >- + The callback `PUT /parties/{Type}/{ID}` (or `PUT + /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a + successful result of the Party information lookup. + summary: Return party information + tags: + - parties + operationId: PartiesByTypeAndID2 + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Party information returned. + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/GetParties_IdentificationVerificationReportV03 + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /parties/{Type}/{ID}/error: + put: + description: >- + If the server is unable to find Party information of the provided + identity, or another processing error occurred, the error callback `PUT + /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) + is used. + summary: Return party information error + tags: + - parties + operationId: PartiesErrorByTypeAndID + parameters: + - $ref: "#/components/parameters/Type" + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/GetPartiesError_IdentificationVerificationReportV03 + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /parties/{Type}/{ID}/{SubId}: + parameters: + - $ref: "#/components/parameters/Type" + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/SubId" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + get: + description: >- + The HTTP request `GET /parties/{Type}/{ID}` (or `GET + /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding + the requested Party, defined by `{Type}`, `{ID}` and optionally + `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET + /parties/BUSINESS/shoecompany/employee1`). + summary: Look up party information + tags: + - parties + operationId: PartiesSubIdByTypeAndID + parameters: + - $ref: "#/components/parameters/Accept" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + put: + description: >- + The callback `PUT /parties/{Type}/{ID}` (or `PUT + /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a + successful result of the Party information lookup. + summary: Return party information + tags: + - parties + operationId: PartiesSubIdByTypeAndIDPut + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Party information returned. + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/GetParties_IdentificationVerificationReportV03 + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /parties/{Type}/{ID}/{SubId}/error: + put: + description: >- + If the server is unable to find Party information of the provided + identity, or another processing error occurred, the error callback `PUT + /parties/{Type}/{ID}/error` (or `PUT + /parties/{Type}/{ID}/{SubId}/error`) is used. + summary: Return party information error + tags: + - parties + operationId: PartiesSubIdErrorByTypeAndID + parameters: + - $ref: "#/components/parameters/Type" + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/SubId" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/GetPartiesError_IdentificationVerificationReportV03 + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /quotes: + post: + description: >- + The HTTP request `POST /quotes` is used to request the creation of a + quote for the provided financial transaction in the server. + summary: Calculate quote + tags: + - quotes + operationId: Quotes + parameters: + - $ref: "#/components/parameters/Accept" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the quote to be created. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/TermsRequest_FIToFICustomerCreditProposal" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /quotes/{ID}: + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + get: + description: >- + The HTTP request `GET /quotes/{ID}` is used to get information regarding + a quote created or requested earlier. The `{ID}` in the URI should + contain the `quoteId` that was used for the creation of the quote. + summary: Retrieve quote information + tags: + - quotes + operationId: QuotesByID + parameters: + - $ref: "#/components/parameters/Accept" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + put: + description: >- + The callback `PUT /quotes/{ID}` is used to inform the client of a + requested or created quote. The `{ID}` in the URI should contain the + `quoteId` that was used for the creation of the quote, or the `{ID}` + that was used in the `GET /quotes/{ID}` request. + summary: Return quote information + tags: + - quotes + operationId: QuotesByID1 + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Quote information returned. + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /quotes/{ID}/error: + put: + description: >- + If the server is unable to find or create a quote, or some other + processing error occurs, the error callback `PUT /quotes/{ID}/error` is + used. The `{ID}` in the URI should contain the `quoteId` that was used + for the creation of the quote, or the `{ID}` that was used in the `GET + /quotes/{ID}` request. + summary: Return quote information error + tags: + - quotes + operationId: QuotesByIDAndError + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /transfers: + post: + description: >- + The HTTP request `POST /transfers` is used to request the creation of a + transfer for the next ledger, and a financial transaction for the Payee + FSP. + summary: Perform transfer + tags: + - transfers + operationId: transfers + parameters: + - $ref: "#/components/parameters/Accept" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the transfer to be created. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Execute_FIToFICustomerCreditTransferV13" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /transfers/{ID}: + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + get: + description: >- + The HTTP request `GET /transfers/{ID}` is used to get information + regarding a transfer created or requested earlier. The `{ID}` in the URI + should contain the `transferId` that was used for the creation of the + transfer. + summary: Retrieve transfer information + tags: + - transfers + operationId: TransfersByIDGet + parameters: + - $ref: "#/components/parameters/Accept" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + patch: + description: >- + The HTTP request PATCH /transfers/ is used by a Switch to update the + state of a previously reserved transfer, if the Payee FSP has requested + a commit notification when the Switch has completed processing of the + transfer. The in the URI should contain the transferId that was + used for the creation of the transfer. Please note that this request + does not generate a callback. + summary: Return transfer information + tags: + - transfers + operationId: TransfersByIDPatch + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Transfer notification upon completion. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + put: + description: >- + The callback `PUT /transfers/{ID}` is used to inform the client of a + requested or created transfer. The `{ID}` in the URI should contain the + `transferId` that was used for the creation of the transfer, or the + `{ID}` that was used in the `GET /transfers/{ID}` request. + summary: Return transfer information + tags: + - transfers + operationId: TransfersByIDPut + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Transfer information returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /transfers/{ID}/error: + put: + description: >- + If the server is unable to find or create a transfer, or another + processing error occurs, the error callback `PUT /transfers/{ID}/error` + is used. The `{ID}` in the URI should contain the `transferId` that was + used for the creation of the transfer, or the `{ID}` that was used in + the `GET /transfers/{ID}`. + summary: Return transfer information error + tags: + - transfers + operationId: TransfersByIDAndError + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /fxQuotes: + post: + description: >- + The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a + quotation for a currency conversion. + summary: Calculate FX quote + tags: + - fxQuotes + operationId: FxQuotesPost + parameters: + - $ref: "#/components/parameters/Accept" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the FX quote to be created. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/FxRequest_FICreditTransferProposal" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /fxQuotes/{ID}: + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + get: + description: >- + The HTTP request `GET /fxQuotes/{ID}` is used to request information + regarding a request for quotation for a currency conversion which the + sender has previously issued. The `{ID}` in the URI should contain the + `conversionRequestId` that was used for the creation of the quote. + summary: Retrieve FX quote information + tags: + - fxQuotes + operationId: FxQuotesByIDGet + parameters: + - $ref: "#/components/parameters/Accept" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + put: + description: >- + The callback `PUT /fxQuotes/{ID}` is used to inform the requester about + the outcome of a request for quotation for a currency conversion. The + `{ID}` in the URI should contain the `conversionRequestId` that was used + for the creation of the FX quote, or the `{ID}` that was used in the + `GET /fxQuotes/{ID}` request. + summary: Return FX quote information + tags: + - fxQuotes + operationId: FxQuotesByIdPut + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: FX Quote information returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/FxResponse_FICreditTransferConfirmation" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /fxQuotes/{ID}/error: + put: + description: >- + If the FXP is unable to find or create a FX quote, or some other + processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` + is used. The `{ID}` in the URI should contain the `conversionRequestId` + that was used for the creation of the FX quote, or the `{ID}` that was + used in the `GET /fxQuotes/{ID}` request. + summary: Return FX quote information error + tags: + - fxQuotes + operationId: FxQuotesByIDAndErrorPut + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /fxTransfers: + post: + description: >- + The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm + the execution of an agreed currency conversion. + summary: Perform FX transfer + tags: + - fxTransfers + operationId: FxTransfersPost + parameters: + - $ref: "#/components/parameters/Accept" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the FX transfer to be created. + required: true + content: + application/json: + schema: + $ref: >- + #/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12 + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /fxTransfers/{ID}: + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + get: + description: >- + The HTTP request `GET /fxTransfers/{ID}` s used to request information + regarding a request for confirmation of a currency conversion which the + sender has previously issued. The `{ID}` in the URI should contain the + `commitRequestId` that was used for the creation of the FX transfer. + summary: Retrieve FX transfer information + tags: + - fxTransfers + operationId: FxTransfersByIDGet + parameters: + - $ref: "#/components/parameters/Accept" + responses: + "202": + $ref: "#/components/responses/202" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + patch: + description: >- + The HTTP request PATCH /fxTransfers/ is used to inform the requester + about the final determination by the switch of the transfer a request + for execution of a currency conversion. The in the URI should + contain the commitRequestId that was used for the creation of the FX + transfer. Please note that this request does not generate a callback. + summary: Return FX transfer information + tags: + - fxTransfers + operationId: FxTransfersByIDPatch + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Transfer notification upon completion. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + put: + description: >- + The callback `PUT /fxTransfers/{ID}` is used to inform the requester + about the outcome of a request for execution of a currency conversion. + The `{ID}` in the URI should contain the `commitRequestId` that was used + for the creation of the FX transfer, or the `{ID}` that was used in the + `GET /fxTransfers/{ID}` request. + summary: Return FX transfer information + tags: + - fxTransfers + operationId: FxTransfersByIDPut + parameters: + - $ref: "#/components/parameters/Content-Length" + requestBody: + description: Transfer information returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" + /fxTransfers/{ID}/error: + put: + description: >- + If the switch or FXP is unable to find or create a FX transfer, or + another processing error occurs, the error callback `PUT + /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain + the `commitRequestId` that was used for the creation of the FX transfer, + or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. + summary: Return FX transfer information error + tags: + - fxTransfers + operationId: FxTransfersByIDAndErrorPut + parameters: + - $ref: "#/components/parameters/ID" + - $ref: "#/components/parameters/Content-Length" + - $ref: "#/components/parameters/Content-Type" + - $ref: "#/components/parameters/Date" + - $ref: "#/components/parameters/X-Forwarded-For" + - $ref: "#/components/parameters/FSPIOP-Source" + - $ref: "#/components/parameters/FSPIOP-Destination" + - $ref: "#/components/parameters/FSPIOP-Encryption" + - $ref: "#/components/parameters/FSPIOP-Signature" + - $ref: "#/components/parameters/FSPIOP-URI" + - $ref: "#/components/parameters/FSPIOP-HTTP-Method" + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15" + responses: + "200": + $ref: "#/components/responses/200" + "400": + $ref: "#/components/responses/400" + "401": + $ref: "#/components/responses/401" + "403": + $ref: "#/components/responses/403" + "404": + $ref: "#/components/responses/404" + "405": + $ref: "#/components/responses/405" + "406": + $ref: "#/components/responses/406" + "501": + $ref: "#/components/responses/501" + "503": + $ref: "#/components/responses/503" +components: + parameters: + Accept: + name: Accept + in: header + required: true + schema: + type: string + description: >- + The `Accept` header field indicates the version of the API the client + would like the server to use. + Content-Length: + name: Content-Length + in: header + required: false + schema: + type: integer + description: >- + The `Content-Length` header field indicates the anticipated size of the + payload body. Only sent if there is a body. + + + **Note:** The API supports a maximum size of 5242880 bytes (5 + Megabytes). + Content-Type: + name: Content-Type + in: header + schema: + type: string + required: true + description: >- + The `Content-Type` header indicates the specific version of the API used + to send the payload body. + Date: + name: Date + in: header + schema: + type: string + required: true + description: The `Date` header field indicates the date when the request was sent. + FSPIOP-Destination: + name: FSPIOP-Destination + in: header + schema: + type: string + required: false + description: >- + The `FSPIOP-Destination` header field is a non-HTTP standard field used + by the API for HTTP header based routing of requests and responses to + the destination. The field must be set by the original sender of the + request if the destination is known (valid for all services except GET + /parties) so that any entities between the client and the server do not + need to parse the payload for routing purposes. If the destination is + not known (valid for service GET /parties), the field should be left + empty. + FSPIOP-Encryption: + name: FSPIOP-Encryption + in: header + schema: + type: string + required: false + description: >- + The `FSPIOP-Encryption` header field is a non-HTTP standard field used + by the API for applying end-to-end encryption of the request. + FSPIOP-HTTP-Method: + name: FSPIOP-HTTP-Method + in: header + schema: + type: string + required: false + description: >- + The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used + by the API for signature verification, should contain the service HTTP + method. Required if signature verification is used, for more + information, see [the API Signature + document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). + FSPIOP-Signature: + name: FSPIOP-Signature + in: header + schema: + type: string + required: false + description: >- + The `FSPIOP-Signature` header field is a non-HTTP standard field used by + the API for applying an end-to-end request signature. + FSPIOP-Source: + name: FSPIOP-Source + in: header + schema: + type: string + required: true + description: >- + The `FSPIOP-Source` header field is a non-HTTP standard field used by + the API for identifying the sender of the HTTP request. The field should + be set by the original sender of the request. Required for routing and + signature verification (see header field `FSPIOP-Signature`). + FSPIOP-URI: + name: FSPIOP-URI + in: header + schema: + type: string + required: false + description: >- + The `FSPIOP-URI` header field is a non-HTTP standard field used by the + API for signature verification, should contain the service URI. Required + if signature verification is used, for more information, see [the API + Signature + document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). + ID: + name: ID + in: path + required: true + schema: + type: string + description: The identifier value. + SubId: + name: SubId + in: path + required: true + schema: + type: string + description: >- + A sub-identifier of the party identifier, or a sub-type of the party + identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. + Type: + name: Type + in: path + required: true + schema: + type: string + description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. + X-Forwarded-For: + name: X-Forwarded-For + in: header + schema: + type: string + required: false + description: >- + The `X-Forwarded-For` header field is an unofficially accepted standard + used for informational purposes of the originating client IP address, as + a request might pass multiple proxies, firewalls, and so on. Multiple + `X-Forwarded-For` values should be expected and supported by + implementers of the API. + + + **Note:** An alternative to `X-Forwarded-For` is defined in [RFC + 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC + 7239 is less-used and supported than `X-Forwarded-For`. + responses: + "200": + description: OK + "202": + description: Accepted + "400": + description: Bad Request + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "403": + description: Forbidden + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "404": + description: Not Found + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "405": + description: Method Not Allowed + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "406": + description: Not Acceptable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "501": + description: Not Implemented + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + "503": + description: Service Unavailable + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorInformationResponse" + headers: + Content-Length: + $ref: "#/components/headers/Content-Length" + Content-Type: + $ref: "#/components/headers/Content-Type" + headers: + Content-Length: + required: false + schema: + type: integer + description: >- + The `Content-Length` header field indicates the anticipated size of the + payload body. Only sent if there is a body. + + + **Note:** The API supports a maximum size of 5242880 bytes (5 + Megabytes). + Content-Type: + schema: + type: string + required: true + description: >- + The `Content-Type` header indicates the specific version of the API used + to send the payload body. + schemas: + AccountIdentification4Choice: + title: AccountIdentification4Choice + type: object + description: > + Specifies the unique identification of an account as assigned by the + account servicer. + properties: + IBAN: + $ref: "#/components/schemas/IBAN2007Identifier" + Othr: + $ref: "#/components/schemas/GenericAccountIdentification1" + oneOf: + - required: + - IBAN + - required: + - Othr + example: + IBAN: BE71096123456769 + AccountSchemeName1Choice: + title: AccountSchemeName1Choice + type: object + description: | + Sets of elements to identify a name of the identification scheme. + properties: + Cd: + $ref: "#/components/schemas/ExternalAccountIdentification1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: 1111 + ActiveCurrencyAndAmount: + title: ActiveCurrencyAndAmount + type: object + description: > + A number of monetary units specified in an active currency where the + unit of currency is explicit and compliant with ISO 4217. + properties: + ActiveCurrencyAndAmount: + $ref: "#/components/schemas/ActiveCurrencyAndAmount_SimpleType" + Ccy: + $ref: "#/components/schemas/ActiveCurrencyCode" + required: + - ActiveCurrencyAndAmount + - Ccy + example: + ActiveCurrencyAndAmount: 123.45 + Ccy: USD + ActiveCurrencyAndAmount_SimpleType: + title: ActiveCurrencyAndAmount_SimpleType + type: string + description: | + NOTE: This regex doesn't seem correct given it's xsd definition. + + + + + + + + pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ + example: 123.45 + ActiveCurrencyCode: + title: ActiveCurrencyCode + type: string + pattern: ^[A-Z]{3,3}$ + description: >- + A code allocated to a currency by a Maintenance Agency under an + international identification scheme as described in the latest edition + of the international standard ISO 4217 "Codes for the representation of + currencies and funds". + example: USD + ActiveOrHistoricCurrencyAndAmount: + title: ActiveOrHistoricCurrencyAndAmount + type: object + description: > + A number of monetary units specified in an active or a historic currency + where the unit of currency is explicit and compliant with ISO 4217. + properties: + ActiveOrHistoricCurrencyAndAmount: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType" + Ccy: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode" + required: + - ActiveOrHistoricCurrencyAndAmount + - Ccy + example: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + ActiveOrHistoricCurrencyAndAmount_SimpleType: + title: ActiveOrHistoricCurrencyAndAmount_SimpleType + type: string + pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ + example: 123.45 + ActiveOrHistoricCurrencyCode: + title: ActiveOrHistoricCurrencyCode + type: string + description: > + A code allocated to a currency by a Maintenance Agency under an + international identification scheme, as described in the latest edition + of the international standard ISO 4217 "Codes for the representation of + currencies and funds". + pattern: ^[A-Z]{3,3}$ + example: USD + AddressType2Code: + description: | + AddressType2Code + Specifies the type of address. + enum: + - ADDR + - PBOX + - HOME + - BIZZ + - MLTO + - DLVY + type: string + example: ADDR + AddressType3Choice: + title: AddressType3Choice + type: object + description: | + Choice of formats for the type of address. + properties: + Cd: + $ref: "#/components/schemas/AddressType2Code" + Prtry: + $ref: "#/components/schemas/GenericIdentification30" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: ADDR + AnyBICDec2014Identifier: + title: AnyBICDec2014Identifier + type: string + description: > + AnyBICDec2014Identifier + + Code allocated to a financial or non-financial institution by the + + ISO 9362 Registration Authority, as described in ISO 9362: 2014 + + - "Banking - Banking telecommunication messages - Business identifier + code (BIC)". + pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ + example: J5BMVH7D + BICFIDec2014Identifier: + title: BICFIDec2014Identifier + type: string + description: > + Code allocated to a financial institution by the ISO 9362 Registration + + + Authority as described in ISO 9362: 2014 + + + - "Banking - Banking telecommunication messages - Business identifier + code (BIC)". + pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ + example: J5BMVH7D + BaseOneRate: + title: BaseOneRate + type: string + description: | + Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. + pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ + example: 0.7 + BranchAndFinancialInstitutionIdentification6: + title: BranchAndFinancialInstitutionIdentification6 + type: object + description: > + Unique and unambiguous identification of a financial institution or a + branch of a financial institution. + properties: + FinInstnId: + $ref: "#/components/schemas/FinancialInstitutionIdentification18" + BrnchId: + $ref: "#/components/schemas/BranchData3" + required: + - FinInstnId + example: + FinInstnId: + BICFI: J5BMVH7D + BrnchId: + Id: 123 + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: Sub department + StrtNm: Street name + BldgNb: Building number + PstCd: Post code + TwnNm: Town name + CtrySubDvsn: Country subdivision + Ctry: Country + AdrLine: Address line + BranchAndFinancialInstitutionIdentification8: + title: BranchAndFinancialInstitutionIdentification8 + type: object + description: > + Unique and unambiguous identification of a financial institution or a + branch of a financial institution. + properties: + FinInstnId: + $ref: "#/components/schemas/FinancialInstitutionIdentification23" + BrnchId: + $ref: "#/components/schemas/BranchData5" + required: + - FinInstnId + example: + FinInstnId: + BICFI: BUKBGB22 + BrnchId: + Id: 12345 + Nm: Oxford Street Branch + PstlAdr: + Ctry: GB + AdrLine: + - 1 Oxford Street + - London + - UK + BranchData3: + title: BranchData3 + type: object + description: > + Information that locates and identifies a specific branch of a financial + institution. + properties: + Id: + $ref: "#/components/schemas/Max35Text" + LEI: + $ref: "#/components/schemas/LEIIdentifier" + Nm: + $ref: "#/components/schemas/Max140Text" + PstlAdr: + $ref: "#/components/schemas/PostalAddress24" + example: + Id: 123 + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: Sub department + StrtNm: Street name + BldgNb: Building number + PstCd: Post code + TwnNm: Town name + CtrySubDvsn: Country subdivision + Ctry: Country + AdrLine: Address line + BranchData5: + title: BranchData5 + description: > + Information that locates and identifies a specific branch of a financial + institution. + type: object + properties: + Id: + $ref: "#/components/schemas/Max35Text" + LEI: + $ref: "#/components/schemas/LEIIdentifier" + Nm: + $ref: "#/components/schemas/Max140Text" + PstlAdr: + $ref: "#/components/schemas/PostalAddress27" + example: + Id: 123 + Nm: Oxford Street Branch + PstlAdr: + Ctry: GB + AdrLine: + - 1 Oxford Street + - London + - UK + CashAccount40: + title: CashAccount40 + type: object + description: | + Provides the details to identify an account. + properties: + Id: + $ref: "#/components/schemas/AccountIdentification4Choice" + Tp: + $ref: "#/components/schemas/CashAccountType2Choice" + Ccy: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyCode" + Nm: + $ref: "#/components/schemas/Max70Text" + Prxy: + $ref: "#/components/schemas/ProxyAccountIdentification1" + example: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + Prxy: + Id: 12345 + CashAccountType2Choice: + title: CashAccountType2Choice + description: | + Specifies the nature, or use of the account. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalCashAccountType1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CACC + CategoryPurpose1Choice: + title: CategoryPurpose1Choice + description: > + Contains details about high level purpose of the mandate based on a set + of pre-defined categories. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalCategoryPurpose1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CASH + ChargeBearerType1Code: + title: ChargeBearerType1Code + description: > + Specifies which party(ies) will pay charges due for processing of the + instruction. + + DEBT BorneByDebtor All transaction charges are to be borne by the + debtor. + + CRED BorneByCreditor All transaction charges are to be borne by the + creditor. + + SHAR Shared In a credit transfer context, means that transaction charges + on the sender side are to be borne by the debtor, transaction charges on + the receiver side are to be borne by the creditor. In a direct debit + context, means that transaction charges on the sender side are to be + borne by the creditor, transaction charges on the receiver + + SLEV FollowingServiceLevel Charges are to be applied following the rules + agreed in the service level. + type: string + enum: + - DEBT + - CRED + - SHAR + - SLEV + example: DEBT + ChargeType3Choice: + title: ChargeType3Choice + description: ChargeType3Choice Specifies the type of charge. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalChargeType1Code" + Prtry: + $ref: "#/components/schemas/GenericIdentification3" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CASH + Charges16: + title: Charges16 + description: | + NOTE: Unsure on description. + type: object + properties: + Amt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + Agt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + Tp: + $ref: "#/components/schemas/ChargeType3Choice" + required: + - Amt + - Agt + example: + Amt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + Agt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Tp: + Cd: SHAR + ClearingChannel2Code: + title: ClearingChannel2Code + description: > + Specifies the clearing channel for the routing of the transaction, as + part of the payment type identification. + + RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross + settlement system. + + RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net + settlement system. + + MPNS MassPaymentNetSystem Clearing channel is a mass payment net + settlement system. + + BOOK BookTransfer Payment through internal book transfer. + type: string + enum: + - RTGS + - RTNS + - MPNS + - BOOK + example: RTGS + ClearingSystemIdentification2Choice: + title: ClearingSystemIdentification2Choice + description: | + Choice of a clearing system identifier. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalClearingSystemIdentification1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CHQB + ClearingSystemMemberIdentification2: + title: ClearingSystemMemberIdentification2 + description: > + Unique identification, as assigned by a clearing system, to + unambiguously identify a member of the clearing system. + type: object + properties: + ClrSysId: + $ref: "#/components/schemas/ClearingSystemIdentification2Choice" + MmbId: + $ref: "#/components/schemas/Max35Text" + required: + - MmbId + example: + ClrSysId: + Cd: CHQB + MmbId: 123456789 + Contact13: + title: Contact13 + description: | + Specifies the details of the contact person. + type: object + properties: + NmPrfx: + $ref: "#/components/schemas/NamePrefix2Code" + Nm: + $ref: "#/components/schemas/Max140Text" + PhneNb: + $ref: "#/components/schemas/PhoneNumber" + MobNb: + $ref: "#/components/schemas/PhoneNumber" + FaxNb: + $ref: "#/components/schemas/PhoneNumber" + URLAdr: + $ref: "#/components/schemas/Max2048Text" + EmailAdr: + $ref: "#/components/schemas/Max256Text" + EmailPurp: + $ref: "#/components/schemas/Max35Text" + JobTitl: + $ref: "#/components/schemas/Max35Text" + Rspnsblty: + $ref: "#/components/schemas/Max35Text" + Dept: + $ref: "#/components/schemas/Max70Text" + Othr: + $ref: "#/components/schemas/OtherContact1" + PrefrdMtd: + $ref: "#/components/schemas/PreferredContactMethod2Code" + example: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + URLAdr: http://www.example.com + EmailAdr: example@example.com + Contact4: + title: Contact4 + description: | + Specifies the details of the contact person. + type: object + properties: + NmPrfx: + $ref: "#/components/schemas/NamePrefix2Code" + Nm: + $ref: "#/components/schemas/Max140Text" + PhneNb: + $ref: "#/components/schemas/PhoneNumber" + MobNb: + $ref: "#/components/schemas/PhoneNumber" + FaxNb: + $ref: "#/components/schemas/PhoneNumber" + EmailAdr: + $ref: "#/components/schemas/Max2048Text" + EmailPurp: + $ref: "#/components/schemas/Max35Text" + JobTitl: + $ref: "#/components/schemas/Max35Text" + Rspnsblty: + $ref: "#/components/schemas/Max35Text" + Dept: + $ref: "#/components/schemas/Max70Text" + Othr: + $ref: "#/components/schemas/OtherContact1" + PrefrdMtd: + $ref: "#/components/schemas/PreferredContactMethod1Code" + example: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: example@example.com + CountryCode: + title: CountryCode + type: string + pattern: ^[A-Z]{2,2}$ + example: US + CreditTransferTransaction67: + title: CreditTransferTransaction67 + description: > + Provides further details specific to the individual transaction(s) + included in the message. + type: object + properties: + PmtId: + $ref: "#/components/schemas/PaymentIdentification13" + PmtTpInf: + $ref: "#/components/schemas/PaymentTypeInformation28" + IntrBkSttlmAmt: + $ref: "#/components/schemas/ActiveCurrencyAndAmount" + InstdAmt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + XchgRate: + $ref: "#/components/schemas/BaseOneRate" + ChrgBr: + $ref: "#/components/schemas/ChargeBearerType1Code" + ChrgsInf: + $ref: "#/components/schemas/Charges16" + Dbtr: + $ref: "#/components/schemas/PartyIdentification272" + DbtrAcct: + $ref: "#/components/schemas/CashAccount40" + DbtrAgt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + CdtrAgt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + Cdtr: + $ref: "#/components/schemas/PartyIdentification272" + CdtrAcct: + $ref: "#/components/schemas/CashAccount40" + InstrForCdtrAgt: + $ref: "#/components/schemas/InstructionForCreditorAgent3" + InstrForNxtAgt: + $ref: "#/components/schemas/InstructionForNextAgent1" + Purp: + $ref: "#/components/schemas/Purpose2Choice" + RgltryRptg: + $ref: "#/components/schemas/RegulatoryReporting3" + Tax: + $ref: "#/components/schemas/TaxData1" + VrfctnOfTerms: + $ref: "#/components/schemas/CryptographicLockChoice" + required: + - PmtId + - IntrBkSttlmAmt + - ChrgBr + - Dbtr + - DbtrAgt + - CdtrAgt + - Cdtr + example: + PmtId: + InstrId: INSTRID + EndToEndId: ENDTOENDID + PmtTpInf: + LclInstrm: + Cd: CHQB + Prtry: PROPRIETARY + SeqTp: SEQTP + IntrBkSttlmAmt: + ActiveCurrencyAndAmount: 123.45 + Ccy: USD + InstdAmt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + XchgRate: 123.45 + ChrgBr: SHAR + ChrgsInf: + Amt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + Agt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Tp: + Cd: SHAR + Dbtr: + Nm: NAME + PstlAdr: + AdrTp: ADDR + BldgNb: BLDGNB + Ctry: CTRY + TwnNm: TWNNM + PstCd: PSTCD + StrtNm: STRTNM + DbtrAcct: + Id: + IBAN: IBAN + DbtrAgt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + CdtrAgt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Cdtr: + Nm: NAME + PstlAdr: + AdrTp: ADDR + BldgNb: BLDGNB + Ctry: CTRY + TwnNm: TWNNM + PstCd: PSTCD + StrtNm: STRTNM + CdtrAcct: + Id: + IBAN: IBAN + InstrForCdtrAgt: + Cd: CODE + InstrForNxtAgt: + Cd: CODE + Purp: + Cd: CASH + RgltryRptg: + Dbtr: true + Cdtr: true + Tax: Cdtr + CreditTransferTransaction68: + title: CreditTransferTransaction68 + description: > + Provides further details specific to the individual transaction(s) + included in the message. + type: object + properties: + PmtId: + $ref: "#/components/schemas/PaymentIdentification13" + PmtTpInf: + $ref: "#/components/schemas/PaymentTypeInformation28" + IntrBkSttlmAmt: + $ref: "#/components/schemas/ActiveCurrencyAndAmount" + Dbtr: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + DbtrAcct: + $ref: "#/components/schemas/CashAccount40" + DbtrAgt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + CdtrAgt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + Cdtr: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8" + CdtrAcct: + $ref: "#/components/schemas/CashAccount40" + InstrForCdtrAgt: + $ref: "#/components/schemas/InstructionForCreditorAgent3" + Purp: + $ref: "#/components/schemas/Purpose2Choice" + VrfctnOfTerms: + $ref: "#/components/schemas/CryptographicLockChoice" + required: + - PmtId + - IntrBkSttlmAmt + - Dbtr + - Cdtr + example: + PmtId: + InstrId: INSTRID + EndToEndId: ENDTOENDID + PmtTpInf: + LclInstrm: + Cd: CHQB + Prtry: PROPRIETARY + IntrBkSttlmAmt: + Amount: 123.45 + Ccy: EUR + Dbtr: + Nm: Debtor Name + DbtrAcct: + Id: + IBAN: IBAN + DbtrAgt: + FinInstnId: + BICFI: BICFI + CdtrAgt: + FinInstnId: + BICFI: BICFI + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: IBAN + InstrForCdtrAgt: + Cd: INSTRUCTION + Purp: + Cd: CHAR + VrfctnOfTerms: + Cntt: CONTENT + CnttTp: PROPRIETARY + CryptographicLockChoice: + title: CryptographicLockChoice + description: | + NOTE: Unsure on description. + type: object + properties: + IlpV4PrepPacket: + $ref: "#/components/schemas/hexBinary" + Sh256Sgntr: + $ref: "#/components/schemas/Exact32HexBinaryText" + oneOf: + - required: + - IlpV4PrepPacket + - required: + - Sh256Sgntr + example: + IlpV4PrepPacket: 1234567890ABCDEF + DateAndPlaceOfBirth1: + title: DateAndPlaceOfBirth1 + description: | + Details about date and place of birth of a person. + type: object + properties: + BirthDt: + $ref: "#/components/schemas/ISODate" + PrvcOfBirth: + $ref: "#/components/schemas/Max35Text" + CityOfBirth: + $ref: "#/components/schemas/Max35Text" + CtryOfBirth: + $ref: "#/components/schemas/CountryCode" + required: + - BirthDt + - CityOfBirth + - CtryOfBirth + example: + BirthDt: "1970-01-01" + PrvcOfBirth: "ON" + CityOfBirth: Ottawa + CtryOfBirth: CA + DatePeriod2: + title: DatePeriod2 + description: | + Range of time defined by a start date and an end date. + type: object + properties: + FrDt: + $ref: "#/components/schemas/ISODate" + ToDt: + $ref: "#/components/schemas/ISODate" + required: + - FrDt + - ToDt + example: + FrDt: "2020-01-01" + ToDt: "2020-12-31" + ErrorCode: + title: ErrorCode + type: string + pattern: ^[1-9]\d{3}$ + description: >- + The API data type ErrorCode is a JSON String of four characters, + consisting of digits only. Negative numbers are not allowed. A leading + zero is not allowed. Each error code in the API is a four-digit number, + for example, 1234, where the first number (1 in the example) represents + the high-level error category, the second number (2 in the example) + represents the low-level error category, and the last two numbers (34 in + the example) represent the specific error. + example: "5100" + ErrorDescription: + title: ErrorDescription + type: string + minLength: 1 + maxLength: 128 + description: Error description string. + ErrorInformation: + title: ErrorInformation + type: object + description: Data model for the complex type ErrorInformation. + properties: + errorCode: + $ref: "#/components/schemas/ErrorCode" + errorDescription: + $ref: "#/components/schemas/ErrorDescription" + extensionList: + $ref: "#/components/schemas/ExtensionList" + required: + - errorCode + - errorDescription + ErrorInformationResponse: + title: ErrorInformationResponse + type: object + description: > + Data model for the complex type object that contains an optional element + ErrorInformation used along with 4xx and 5xx responses. + properties: + errorInformation: + $ref: "#/components/schemas/ErrorInformation" + Exact32HexBinaryText: + title: Exact32HexBinaryText + description: | + Specifies a hexadecimal string with a length of 32 characters. + type: string + pattern: ^([0-9A-F][0-9A-F]){32}$ + example: 1234567890ABCDEF1234567890ABCDEF + Exact4AlphaNumericText: + title: Exact4AlphaNumericText + description: | + Specifies an alphanumeric string with a length of 4 characters. + type: string + pattern: ^[a-zA-Z0-9]{4}$ + example: 1234 + Execute_FIToFICustomerCreditTransferV13: + title: Execute_FIToFICustomerCreditTransferV13 + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader129" + CdtTrfTxInf: + $ref: "#/components/schemas/CreditTransferTransaction67" + required: + - GrpHdr + - CdtTrfTxInf + example: + GrpHdr: + MsgId: 123456789 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + CtrlSum: 100 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: 91 + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + CdtTrfTxInf: + PmtId: + InstrId: 123456789 + EndToEndId: 123456789 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: + Cd: SUPP + InstrForCdtrAgt: + FinInstnId: + BICFI: AAAAAAAA + CdtrAgt: + FinInstnId: + BICFI: AAAAAAAA + Cdtr: + Nm: Creditor Name + PstlAdr: + AdrLine: + - Creditor Address Line 1 + - Creditor Address Line 2 + - Creditor Address Line 3 + - Creditor Address Line 4 + - Creditor Address Line 5 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: 91 + CdtrAcct: + Id: + IBAN: DE87123456781234567890 + RmtInf: + Ustrd: Remittance Information + Extension: + title: Extension + type: object + description: Data model for the complex type Extension. + properties: + key: + $ref: "#/components/schemas/ExtensionKey" + value: + $ref: "#/components/schemas/ExtensionValue" + required: + - key + - value + ExtensionKey: + title: ExtensionKey + type: string + minLength: 1 + maxLength: 32 + description: Extension key. + ExtensionList: + title: ExtensionList + type: object + description: > + Data model for the complex type ExtensionList. An optional list of + extensions, specific to deployment. + properties: + extension: + type: array + items: + $ref: "#/components/schemas/Extension" + minItems: 1 + maxItems: 16 + description: Number of Extension elements. + required: + - extension + ExtensionValue: + title: ExtensionValue + type: string + minLength: 1 + maxLength: 128 + description: Extension value. + ExternalAccountIdentification1Code: + title: ExternalAccountIdentification1Code + description: > + Specifies the external account identification scheme name code in the + format of character string with a maximum length of 4 characters. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalCashAccountType1Code: + title: ExternalCashAccountType1Code + description: > + Specifies the nature, or use, of the cash account in the format of + character string with a maximum length of 4 characters. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalCategoryPurpose1Code: + description: > + Specifies the category purpose, as published in an external category + purpose code list. + + External code sets can be downloaded from www.iso20022.org. + maxLength: 4 + minLength: 1 + type: string + example: 1234 + ExternalChargeType1Code: + title: ExternalChargeType1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalClearingSystemIdentification1Code: + title: ExternalClearingSystemIdentification1Code + type: string + minLength: 1 + maxLength: 5 + example: 12345 + ExternalCreditorAgentInstruction1Code: + title: ExternalCreditorAgentInstruction1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalFinancialInstitutionIdentification1Code: + title: ExternalFinancialInstitutionIdentification1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalLocalInstrument1Code: + title: ExternalLocalInstrument1Code + type: string + minLength: 1 + maxLength: 35 + example: 12345 + ExternalOrganisationIdentification1Code: + title: ExternalOrganisationIdentification1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalPaymentTransactionStatus1Code: + title: ExternalPaymentTransactionStatus1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalPersonIdentification1Code: + title: ExternalPersonIdentification1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalProxyAccountType1Code: + title: ExternalProxyAccountType1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalPurpose1Code: + title: ExternalPurpose1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalServiceLevel1Code: + title: ExternalServiceLevel1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalStatusReason1Code: + title: ExternalStatusReason1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + ExternalVerificationReason1Code: + title: ExternalVerificationReason1Code + type: string + minLength: 1 + maxLength: 4 + example: 1234 + FinancialIdentificationSchemeName1Choice: + title: FinancialIdentificationSchemeName1Choice + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalFinancialInstitutionIdentification1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: BIC + FinancialInstitutionIdentification18: + title: FinancialInstitutionIdentification18 + type: object + properties: + BICFI: + $ref: "#/components/schemas/BICFIDec2014Identifier" + ClrSysMmbId: + $ref: "#/components/schemas/ClearingSystemMemberIdentification2" + LEI: + $ref: "#/components/schemas/LEIIdentifier" + Nm: + $ref: "#/components/schemas/Max140Text" + PstlAdr: + $ref: "#/components/schemas/PostalAddress24" + Othr: + $ref: "#/components/schemas/GenericFinancialIdentification1" + example: + BICFI: BUKBGB22 + Nm: Barclays Bank Plc + PstlAdr: + Ctry: GB + AdrLine: + - 1 Churchill Place + - London + - UK + FinancialInstitutionIdentification23: + title: FinancialInstitutionIdentification23 + type: object + properties: + BICFI: + $ref: "#/components/schemas/BICFIDec2014Identifier" + ClrSysMmbId: + $ref: "#/components/schemas/ClearingSystemMemberIdentification2" + LEI: + $ref: "#/components/schemas/LEIIdentifier" + Nm: + $ref: "#/components/schemas/Max140Text" + PstlAdr: + $ref: "#/components/schemas/PostalAddress27" + Othr: + $ref: "#/components/schemas/GenericFinancialIdentification1" + example: + BICFI: BUKBGB22 + Nm: Barclays Bank Plc + PstlAdr: + Ctry: GB + AdrLine: + - 1 Churchill Place + - London + - UK + FxRequest_FICreditTransferProposal: + title: FxRequest_FICreditTransferProposal + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader113" + required: + - GrpHdr + example: + GrpHdr: + MsgId: 123456789 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + CtrlSum: 100 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + FwdgAgt: + FinInstnId: + BICFI: BICFID0 + Dbtr: + Nm: Debtor Name + PstlAdr: + AdrLine: + - Debtor Address Line 1 + - Debtor Address Line 2 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + DbtrAcct: + Id: + IBAN: BE71096123456769 + DbtrAgt: + FinInstnId: + BICFI: BICFID0 + Cdtr: + Nm: Creditor Name + PstlAdr: + AdrLine: + - Creditor Address Line 1 + - Creditor Address Line 2 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + CdtrAcct: + Id: + IBAN: BE71096123456769 + CdtrAgt: + FinInstnId: + BICFI: BICFID0 + CdtTrfTxInf: + - PmtId: + InstrId: 123456789 + EndToEndId: 123456789 + Amt: + InstdAmt: + Ccy: EUR + Amt: 100 + CdtrAgt: + FinInstnId: + BICFI: BICFID0 + Cdtr: + Nm: Creditor Name + PstlAdr: + AdrLine: + - Creditor Address Line 1 + - Creditor Address Line 2 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + FxResponse_FICreditTransferConfirmation: + title: FxResponse_FICreditTransferConfirmation + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader113" + CdtTrfTxInf: + $ref: "#/components/schemas/CreditTransferTransaction68" + required: + - GrpHdr + - CdtTrfTxInf + example: + GrpHdr: + MsgId: 20191122-123456 + CreDtTm: "2019-11-22T12:34:56" + NbOfTxs: 1 + CtrlSum: 100 + InitgPty: + Nm: Initiating Party Name + MsgRcpt: + Nm: Message Recipient Name + CdtTrfTxInf: + PmtId: + InstrId: 20191122-123456 + EndToEndId: 20191122-123456 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: SUPP + IntrBkSttlmAmt: + Amt: 100 + Ccy: EUR + ChrgBr: SLEV + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + CdtrAgt: + FinInstnId: + BICFI: BNBABEBB + CdtrAgtAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + Dbtr: + Nm: Debtor Name + DbtrAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + DbtrAgt: + FinInstnId: + BICFI: BNBABEBB + DbtrAgtAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + RmtInf: + Ustrd: Remittance Information + RgltryRptg: + Dbtr: + Nm: Debtor Name + DbtrAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + Fxecute_FinancialInstitutionCreditTransferV12: + title: Fxecute_FinancialInstitutionCreditTransferV12 + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader129" + CdtTrfTxInf: + $ref: "#/components/schemas/CreditTransferTransaction68" + required: + - GrpHdr + - CdtTrfTxInf + example: + GrpHdr: + MsgId: 20191113001 + CreDtTm: "2019-11-13T10:00:00" + NbOfTxs: 1 + CtrlSum: 1000 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + Id: 123456789 + SchmeNm: + Cd: BBA + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + DbtrAgt: + FinInstnId: + BICFI: AAAAAAAA + CdtrAgt: + FinInstnId: + BICFI: CCCCCCCC + CdtTrfTxInf: + PmtId: + InstrId: 20191113001 + EndToEndId: 20191113001 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: + Cd: SUPP + InstrForCdtrAgt: + Cd: /ACC/123456789 + IntrBkSttlmAmt: + Amt: 1000 + Ccy: EUR + ChrgBr: SLEV + CdtrAgt: + FinInstnId: + BICFI: CCCCCCCC + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + RmtInf: + Ustrd: Payment for invoice 12345 + GenericAccountIdentification1: + title: GenericAccountIdentification1 + type: object + properties: + Id: + $ref: "#/components/schemas/Max34Text" + SchmeNm: + $ref: "#/components/schemas/AccountSchemeName1Choice" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + GenericFinancialIdentification1: + title: GenericFinancialIdentification1 + type: object + properties: + Id: + $ref: "#/components/schemas/Max35Text" + SchmeNm: + $ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + GenericIdentification3: + title: GenericIdentification3 + type: object + properties: + Id: + $ref: "#/components/schemas/Max35Text" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + Issr: BIC + GenericIdentification30: + title: GenericIdentification30 + type: object + properties: + Id: + $ref: "#/components/schemas/Exact4AlphaNumericText" + Issr: + $ref: "#/components/schemas/Max35Text" + SchmeNm: + $ref: "#/components/schemas/Max35Text" + required: + - Id + - Issr + example: + Id: 1234 + Issr: BIC + SchmeNm: BICFI + GenericOrganisationIdentification1: + title: GenericOrganisationIdentification1 + type: object + properties: + Id: + $ref: "#/components/schemas/Max35Text" + SchmeNm: + $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + GenericOrganisationIdentification3: + title: GenericOrganisationIdentification3 + type: object + properties: + Id: + $ref: "#/components/schemas/Max256Text" + SchmeNm: + $ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + GenericPersonIdentification1: + title: GenericPersonIdentification1 + type: object + properties: + Id: + $ref: "#/components/schemas/Max35Text" + SchmeNm: + $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: DRLC + Issr: BIC + GenericPersonIdentification2: + title: GenericPersonIdentification2 + type: object + properties: + Id: + $ref: "#/components/schemas/Max256Text" + SchmeNm: + $ref: "#/components/schemas/PersonIdentificationSchemeName1Choice" + Issr: + $ref: "#/components/schemas/Max35Text" + required: + - Id + example: + Id: 123 + SchmeNm: + Cd: DRLC + Issr: BIC + GetPartiesError_IdentificationVerificationReportV03: + title: GetPartiesError_IdentificationVerificationReportV03 + type: object + properties: + Assgnmt: + $ref: "#/components/schemas/IdentificationAssignment3" + Rpt: + $ref: "#/components/schemas/VerificationReport4" + SplmtryData: + $ref: "#/components/schemas/SupplementaryData1" + required: + - Assgnmt + - Rpt + example: + Assgnmt: + Id: 123 + CreDtTm: "2013-03-07T16:30:00" + Assgnr: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Assgne: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rpt: + Id: 123 + CreDtTm: "2013-03-07T16:30:00" + RptgPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdDoc: + Nb: 123 + RltdDt: "2013-03-07" + RltdDtTp: + Cd: 123 + Rsn: + Cd: 123 + Prtry: 123 + SplmtryData: + PlcAndNm: 123 + Envlp: 123 + RltdDt: "2013-03-07" + RltdDtTp: + Cd: 123 + GetParties_IdentificationVerificationReportV03: + title: GetParties_IdentificationVerificationReportV03 + type: object + properties: + Assgnmt: + $ref: "#/components/schemas/IdentificationAssignment3" + Rpt: + $ref: "#/components/schemas/VerificationReport4" + SplmtryData: + $ref: "#/components/schemas/SupplementaryData1" + required: + - Assgnmt + - Rpt + example: + Assgnmt: + Id: 123 + CreDtTm: "2013-03-07T16:30:00" + Assgnr: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Assgne: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rpt: + Id: 123 + CreDtTm: "2013-03-07T16:30:00" + RptgPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdDoc: + Nb: 123 + RltdDt: "2013-03-07" + RltdDtTp: + Cd: 123 + Rsn: + Cd: 123 + Prtry: 123 + SplmtryData: + PlcAndNm: 123 + Envlp: 123 + RltdDt: "2013-03-07" + RltdDtTp: + Cd: 123 + GroupHeader113: + title: GroupHeader113 + description: > + Set of characteristics shared by all individual transactions included in + the message. + type: object + properties: + MsgId: + $ref: "#/components/schemas/Max35Text" + CreDtTm: + $ref: "#/components/schemas/ISODateTime" + NbOfTxs: + $ref: "#/components/schemas/Max15NumericText" + TtlIntrBkSttlmAmt: + $ref: "#/components/schemas/ActiveCurrencyAndAmount" + SttlmInf: + $ref: "#/components/schemas/SettlementInstruction15" + PmtTpInf: + $ref: "#/components/schemas/PaymentTypeInformation28" + CdtTrfTxInf: + $ref: "#/components/schemas/CreditTransferTransaction68" + required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + - CdtTrfTxInf + example: + MsgId: 12345 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + TtlIntrBkSttlmAmt: + Ccy: EUR + Value: 100 + SttlmInf: + SttlmMtd: INDA + SttlmAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + SttlmAcctOwnr: + Nm: Name + SttlmAcctSvcr: + Nm: Name + SttlmAgt: + FinInstnId: + BICFI: BIC + PmtTpInf: + InstrPrty: NORM + CtgyPurp: CASH + CdtTrfTxInf: + PmtId: + InstrId: 12345 + EndToEndId: 12345 + Amt: + InstdAmt: + Ccy: EUR + Value: 100 + Cdtr: + Nm: Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + CdtrAgt: + FinInstnId: + BICFI: BIC + CdtrAgtAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + RmtInf: + Ustrd: Test + GroupHeader120: + title: GroupHeader120 + description: > + Set of characteristics shared by all individual transactions included in + the message. + type: object + properties: + MsgId: + $ref: "#/components/schemas/Max35Text" + CreDtTm: + $ref: "#/components/schemas/ISODateTime" + TxInfAndSts: + $ref: "#/components/schemas/PaymentTransaction163" + required: + - MsgId + - CreDtTm + example: + MsgId: 12345 + CreDtTm: "2020-01-01T00:00:00Z" + TxInfAndSts: + StsId: 12345 + OrgnlInstrId: 12345 + OrgnlEndToEndId: 12345 + OrgnlTxId: 12345 + OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000 + TxSts: RJCT + StsRsnInf: + Rsn: RSN + AddtlInf: ADDITIONAL + AccptncDtTm: "2020-01-01T00:00:00Z" + AcctSvcrRef: ACCTSVCRREF + ClrSysRef: CLRSYSREF + ExctnConf: 1234567890ABCDEF + SplmtryData: + PlcAndNm: PLACE + Envlp: ENVELOPE + GroupHeader129: + title: GroupHeader129 + description: > + Set of characteristics shared by all individual transactions included in + the message. + type: object + properties: + MsgId: + $ref: "#/components/schemas/Max35Text" + CreDtTm: + $ref: "#/components/schemas/ISODateTime" + PmtInstrXpryDtTm: + $ref: "#/components/schemas/ISODateTime" + NbOfTxs: + $ref: "#/components/schemas/Max15NumericText" + SttlmInf: + $ref: "#/components/schemas/SettlementInstruction15" + CdtTrfTxInf: + $ref: "#/components/schemas/CreditTransferTransaction67" + required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + - CdtTrfTxInf + example: + MsgId: 12345 + CreDtTm: "2020-01-01T00:00:00Z" + PmtInstrXpryDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + SttlmInf: + SttlmMtd: INDA + SttlmAcct: + Id: + IBAN: 123 + SttlmAcctOwnr: + Nm: John Doe + SttlmAcctSvcr: + BICFI: 123 + CdtTrfTxInf: + PmtId: + InstrId: 123 + EndToEndId: 123 + PmtTpInf: + InstrPrty: NORM + InstdAmt: + Amt: 123 + Ccy: EUR + ChrgBr: SLEV + CdtrAgt: + FinInstnId: + BICFI: 123 + Cdtr: + Nm: John Doe + CdtrAcct: + Id: + IBAN: 123 + RmtInf: + Ustrd: Test + IBAN2007Identifier: + title: IBAN2007Identifier + description: > + The International Bank Account Number is a code used internationally by + financial institutions to uniquely identify the account of a customer at + a financial institution as described in the 2007 edition of the ISO + 13616 standard "Banking and related financial services - + + International Bank Account Number (IBAN)" and replaced by the more + recent edition of the standard. + type: string + pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ + example: FR1420041010050500013M02606 + ISODate: + title: ISODate + description: > + A particular point in the progression of time in a calendar year + expressed in the YYYY-MM-DD format. This representation is defined in + "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 + October 2004" which is aligned with ISO 8601. + type: string + format: date + example: "2013-03-07" + ISODateTime: + title: ISODateTime + description: > + A particular point in the progression of time defined by a mandatory + + date and a mandatory time component, expressed in either UTC time + + format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format + + (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format + + (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in + + "XML Schema Part 2: Datatypes Second Edition - + + W3C Recommendation 28 October 2004" which is aligned with ISO 8601. + + + Note on the time format: + + 1) beginning / end of calendar day + + 00:00:00 = the beginning of a calendar day + + 24:00:00 = the end of a calendar day + + + 2) fractions of second in time format + + Decimal fractions of seconds may be included. In this case, the + + involved parties shall agree on the maximum number of digits that are + allowed. + type: string + format: datetime + example: "2013-03-07T14:44:30.000Z" + ISOYear: + title: ISOYear + description: | + Year represented by YYYY (ISO 8601). + type: string + pattern: ^\d{4}(Z|([+-]\d{2}:\d{2})){0,1}$ + example: 2019 + IdentificationAssignment3: + title: IdentificationAssignment3 + type: object + properties: + MsgId: + $ref: "#/components/schemas/Max35Text" + CreDtTm: + $ref: "#/components/schemas/ISODateTime" + Assgnr: + $ref: "#/components/schemas/Party40Choice" + Assgne: + $ref: "#/components/schemas/Party40Choice" + required: + - MsgId + - CreDtTm + - Assgnr + - Assgne + example: + MsgId: 123 + CreDtTm: "2020-01-01T00:00:00Z" + Assgnr: + OrgId: + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + Assgne: + OrgId: + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + IdentificationInformation4: + title: IdentificationInformation4 + type: object + properties: + Pty: + $ref: "#/components/schemas/PartyIdentification135" + Acct: + $ref: "#/components/schemas/CashAccount40" + Agt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6" + example: + Pty: + Id: + OrgId: + AnyBIC: + BICFI: BICFI + CtryOfRes: FI + Acct: + Id: + IBAN: FI2112345600000785 + Agt: + FinInstnId: + BICFI: BICFI + IdentificationVerificationIndicator: + title: IdentificationVerificationIndicator + type: boolean + example: true + Instruction4Code: + title: Instruction4Code + description: > + Specifies further instructions concerning the processing of a payment + instruction, provided by the sending clearing agent to the next + agent(s). + + PHOA PhoneNextAgent Please advise/contact next agent by phone. + + TELA TelecomNextAgent Please advise/contact next agent by the most + efficient means of telecommunication. + type: string + enum: + - PHOA + - TELA + example: PHOA + InstructionForCreditorAgent3: + title: InstructionForCreditorAgent3 + description: > + Further information related to the processing of the payment + instruction, provided by the initiating party, and intended for the + creditor agent. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code" + InstrInf: + $ref: "#/components/schemas/Max140Text" + example: + Cd: PHOA + InstrInf: Please advise/contact next agent by phone. + InstructionForNextAgent1: + title: InstructionForNextAgent1 + description: > + Further information related to the processing of the payment + instruction, provided by the initiating party, and intended for the + creditor agent. + type: object + properties: + Cd: + $ref: "#/components/schemas/Instruction4Code" + InstrInf: + $ref: "#/components/schemas/Max140Text" + example: + Cd: PHOA + InstrInf: Please advise/contact next agent by phone + LEIIdentifier: + title: LEIIdentifier + description: > + Legal Entity Identifier is a code allocated to a party as described in + ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". + ^([0-9A-Z]{18,18}[0-9]{2,2})$ + type: string + pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ + example: 529900T8BM49AURSDO55 + LocalInstrument2Choice: + title: LocalInstrument2Choice + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalLocalInstrument1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CH03 + Max105Text: + title: Max105Text + description: | + Specifies a character string with a maximum length of 105 characters. + type: string + minLength: 1 + maxLength: 105 + example: 12345 + Max10Text: + title: Max10Text + description: | + Specifies a character string with a maximum length of 10 characters. + type: string + minLength: 1 + maxLength: 10 + example: 1234567890 + Max128Text: + title: Max128Text + description: | + Specifies a character string with a maximum length of 128 characters. + type: string + minLength: 1 + maxLength: 128 + example: 12345 + Max140Text: + title: Max140Text + description: | + Specifies a character string with a maximum length of 140 characters. + type: string + minLength: 1 + maxLength: 140 + example: 12345 + Max15NumericText: + title: Max15NumericText + description: | + Specifies a numeric string with a maximum length of 15 digits. + type: string + pattern: ^[0-9]{1,15}$ + example: 123456789012345 + Max16Text: + title: Max16Text + description: | + Specifies a character string with a maximum length of 16 characters. + type: string + minLength: 1 + maxLength: 16 + example: 1234567890123456 + Max2048Text: + title: Max2048Text + description: | + Specifies a character string with a maximum length of 2048 characters. + type: string + minLength: 1 + maxLength: 2048 + example: 2048 + Max256Text: + title: Max256Text + description: | + Specifies a character string with a maximum length of 256 characters. + type: string + minLength: 1 + maxLength: 256 + example: 256 + Max34Text: + title: Max34Text + description: | + Specifies a character string with a maximum length of 34 characters. + type: string + minLength: 1 + maxLength: 34 + example: 1.2345678901234568e+33 + Max350Text: + title: Max350Text + description: | + Specifies a character string with a maximum length of 350 characters. + type: string + minLength: 1 + maxLength: 350 + example: 350 + Max35Text: + title: Max35Text + description: | + Specifies a character string with a maximum length of 35 characters. + type: string + minLength: 1 + maxLength: 35 + example: 1.234567890123457e+34 + Max4Text: + title: Max4Text + description: | + Specifies a character string with a maximum length of 4 characters. + type: string + minLength: 1 + maxLength: 4 + example: 1234 + Max70Text: + title: Max70Text + description: | + Specifies a character string with a maximum length of 70 characters. + type: string + minLength: 1 + maxLength: 70 + example: 1.2345678901234567e+99 + NamePrefix2Code: + description: | + Specifies the terms used to formally address a person. + enum: + - DOCT + - MADM + - MISS + - MIST + - MIKS + type: string + example: DOCT + Number: + title: Number + type: string + pattern: ^[\d\-\.\,]{1,18}$ + example: 256 + OrganisationIdentification29: + title: OrganisationIdentification29 + description: | + Unique and unambiguous way to identify an organisation. + type: object + properties: + AnyBIC: + $ref: "#/components/schemas/AnyBICDec2014Identifier" + LEI: + $ref: "#/components/schemas/LEIIdentifier" + Othr: + $ref: "#/components/schemas/GenericOrganisationIdentification1" + example: + AnyBIC: BICFI + LEI: 529900T8BM49AURSDO55 + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + OrganisationIdentification39: + title: OrganisationIdentification39 + description: | + Unique and unambiguous way to identify an organisation. + type: object + properties: + AnyBIC: + $ref: "#/components/schemas/AnyBICDec2014Identifier" + LEI: + $ref: "#/components/schemas/LEIIdentifier" + Othr: + $ref: "#/components/schemas/GenericOrganisationIdentification3" + example: + AnyBIC: BICFI + LEI: 529900T8BM49AURSDO55 + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + OrganisationIdentificationSchemeName1Choice: + title: OrganisationIdentificationSchemeName1Choice + description: | + Choice of format for the organisation identification. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalOrganisationIdentification1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: BIC + OtherContact1: + title: OtherContact1 + description: > + Communication device number or electronic address used for + communication. + type: object + properties: + ChanlTp: + $ref: "#/components/schemas/Max4Text" + Id: + $ref: "#/components/schemas/Max128Text" + required: + - ChanlTp + example: + ChanlTp: PHON + Id: 1234567890 + PacsError_FIToFIPaymentStatusReportV15: + title: PacsError_FIToFIPaymentStatusReportV15 + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader120" + TxInfAndSts: + $ref: "#/components/schemas/PaymentTransaction163" + SplmtryData: + $ref: "#/components/schemas/SupplementaryData1" + required: + - GrpHdr + example: + GrpHdr: + MsgId: 12345 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + SttlmInf: + SttlmMtd: INDA + SttlmDt: "2020-01-01" + InstgAgt: + FinInstnId: + BICFI: BICFI + InstdAgt: + FinInstnId: + BICFI: BICFI + TxInfAndSts: + OrgnlInstrId: 12345 + OrgnlEndToEndId: 12345 + TxSts: RJCT + StsRsnInf: + Rsn: RSN + AddtlInf: ADDITIONAL + SplmtryData: + PlcAndNm: PLACE + Envlp: ENVELOPE + PacsStatus_FIToFIPaymentStatusReportV15: + title: PacsStatus_FIToFIPaymentStatusReportV15 + description: | + Unsure on description. + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader120" + required: + - GrpHdr + example: + GrpHdr: + MsgId: 123 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + SttlmInf: + SttlmMtd: INDA + SttlmDt: "2020-01-01" + SttlmTmIndctn: RTGS + SttlmTmReq: "2020-01-01T00:00:00Z" + SttlmAcct: + Id: + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + ClrSys: + Prtry: 123 + InstgAgt: + FinInstnId: + BICFI: 123 + InstdAgt: + FinInstnId: + BICFI: 123 + InstgAgt: + FinInstnId: + BICFI: 123 + InstdAgt: + FinInstnId: + BICFI: 123 + IntrBkSttlmAmt: + Amt: 123 + Ccy: EUR + IntrBkSttlmDt: "2020-01-01" + TxSts: ACCP + StsRsnInf: + Orgtr: + Id: + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rsn: + Cd: 123 + Prtry: 123 + TxInfAndSts: + OrgnlInstrId: 123 + OrgnlEndToEndId: 123 + TxSts: ACCP + StsRsnInf: + Orgtr: + Id: + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rsn: + Cd: 123 + Prtry: 123 + ChrgsInf: + Amt: 123 + Ccy: EUR + IntrBkSttlmAmt: + Amt: 123 + Ccy: EUR + IntrBkSttlmDt: "2020-01-01" + SttlmTmIndctn: RTGS + Party38Choice: + title: Party38Choice + description: | + Nature or use of the account. + type: object + properties: + OrgId: + $ref: "#/components/schemas/OrganisationIdentification29" + PrvtId: + $ref: "#/components/schemas/PersonIdentification13" + oneOf: + - required: + - OrgId + - required: + - PrvtId + example: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: "2018-01-01" + CityOfBirth: City + Party40Choice: + title: Party40Choice + description: | + Nature or use of the account. + type: object + properties: + Pty: + $ref: "#/components/schemas/PartyIdentification135" + Agt: + $ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6" + oneOf: + - required: + - Pty + - required: + - Agt + example: + Pty: + Nm: Name + PstlAdr: + Ctry: US + AdrLine: + - Line1 + - Line2 + Id: + OrgId: + AnyBIC: BIC + Agt: + FinInstnId: + BICFI: BUKBGB22 + BrnchId: + Id: 12345 + Nm: Oxford Street Branch + PstlAdr: + Ctry: GB + AdrLine: + - 1 Oxford Street + - London + - UK + Party52Choice: + title: Party52Choice + description: | + Nature or use of the account. + type: object + properties: + OrgId: + $ref: "#/components/schemas/OrganisationIdentification39" + PrvtId: + $ref: "#/components/schemas/PersonIdentification18" + oneOf: + - required: + - OrgId + - required: + - PrvtId + example: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: "2018-01-01" + CityOfBirth: City + PartyIdentification135: + title: PartyIdentification135 + description: | + Specifies the identification of a person or an organisation. + type: object + properties: + Nm: + $ref: "#/components/schemas/Max140Text" + PstlAdr: + $ref: "#/components/schemas/PostalAddress24" + Id: + $ref: "#/components/schemas/Party38Choice" + CtryOfRes: + $ref: "#/components/schemas/CountryCode" + CtctDtls: + $ref: "#/components/schemas/Contact4" + example: + Nm: John Doe + PstlAdr: + Ctry: BE + AdrLine: + - Rue du Marché 45 + - Brussels + - BE + Id: + OrgId: + AnyBIC: CCCCUS33 + CtryOfRes: BE + CtctDtls: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: null + PartyIdentification272: + title: PartyIdentification272 + description: | + Specifies the identification of a person or an organisation. + type: object + properties: + Nm: + $ref: "#/components/schemas/Max140Text" + PstlAdr: + $ref: "#/components/schemas/PostalAddress27" + Id: + $ref: "#/components/schemas/Party52Choice" + CtryOfRes: + $ref: "#/components/schemas/CountryCode" + CtctDtls: + $ref: "#/components/schemas/Contact13" + example: + Nm: John Doe + PstlAdr: + AdrTp: ADDR + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + PstCd: PstCd + TwnNm: TwnNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + Id: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: "2018-01-01" + CityOfBirth: City + CtryOfRes: BE + CtctDtls: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: null + PaymentIdentification13: + title: PaymentIdentification13 + description: | + Provides further means of referencing a payment transaction. + type: object + properties: + InstrId: + $ref: "#/components/schemas/Max35Text" + EndToEndId: + $ref: "#/components/schemas/Max35Text" + TxId: + $ref: "#/components/schemas/Max35Text" + UETR: + $ref: "#/components/schemas/UUIDv4Identifier" + ClrSysRef: + $ref: "#/components/schemas/Max35Text" + required: + - EndToEndId + example: + InstrId: INSTRUCTIONID + EndToEndId: ENDTOENDID + TxId: TRANSACTIONID + UETR: 123e4567-e89b-12d3-a456-426614174000 + ClrSysRef: CLRSYSREF + PaymentTransaction163: + title: PaymentTransaction163 + description: > + Provides further details on the original transactions, to which the + status report message refers. + type: object + properties: + StsId: + $ref: "#/components/schemas/Max35Text" + OrgnlInstrId: + $ref: "#/components/schemas/Max35Text" + OrgnlEndToEndId: + $ref: "#/components/schemas/Max35Text" + OrgnlTxId: + $ref: "#/components/schemas/Max35Text" + OrgnlUETR: + $ref: "#/components/schemas/UUIDv4Identifier" + TxSts: + $ref: "#/components/schemas/ExternalPaymentTransactionStatus1Code" + StsRsnInf: + $ref: "#/components/schemas/StatusReasonInformation14" + AccptncDtTm: + $ref: "#/components/schemas/ISODateTime" + AcctSvcrRef: + $ref: "#/components/schemas/Max35Text" + ClrSysRef: + $ref: "#/components/schemas/Max35Text" + ExctnConf: + $ref: "#/components/schemas/Exact32HexBinaryText" + SplmtryData: + $ref: "#/components/schemas/SupplementaryData1" + example: + StsId: 12345 + OrgnlInstrId: 12345 + OrgnlEndToEndId: 12345 + OrgnlTxId: 12345 + OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000 + TxSts: RJCT + StsRsnInf: + Rsn: RSN + AddtlInf: ADDITIONAL + AccptncDtTm: "2020-01-01T00:00:00Z" + AcctSvcrRef: ACCTSVCRREF + ClrSysRef: CLRSYSREF + ExctnConf: 1234567890ABCDEF + SplmtryData: + PlcAndNm: PLACE + Envlp: ENVELOPE + PaymentTypeInformation28: + title: PaymentTypeInformation28 + description: | + Provides further details of the type of payment. + type: object + properties: + InstrPrty: + $ref: "#/components/schemas/Priority2Code" + ClrChanl: + $ref: "#/components/schemas/ClearingChannel2Code" + SvcLvl: + $ref: "#/components/schemas/ServiceLevel8Choice" + LclInstrm: + $ref: "#/components/schemas/LocalInstrument2Choice" + CtgyPurp: + $ref: "#/components/schemas/CategoryPurpose1Choice" + example: + InstrPrty: NORM + ClrChanl: RTGS + SvcLvl: + Cd: SEPA + LclInstrm: + Cd: CORE + CtgyPurp: + Cd: CASH + PercentageRate: + title: PercentageRate + type: string + pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ + example: 1234 + PersonIdentification13: + title: PersonIdentification13 + description: | + Unique and unambiguous way to identify a person. + type: object + properties: + DtAndPlcOfBirth: + $ref: "#/components/schemas/DateAndPlaceOfBirth1" + Othr: + $ref: "#/components/schemas/GenericPersonIdentification1" + example: + DtAndPlcOfBirth: + Dt: "2018-01-01" + CityOfBirth: City + Othr: + Id: 123 + SchmeNm: + Cd: CUST + Prtry: 1 + PersonIdentification18: + title: PersonIdentification18 + description: | + Unique and unambiguous way to identify a person. + type: object + properties: + DtAndPlcOfBirth: + $ref: "#/components/schemas/DateAndPlaceOfBirth1" + Othr: + $ref: "#/components/schemas/GenericPersonIdentification2" + example: + DtAndPlcOfBirth: + Dt: "2018-01-01" + CityOfBirth: City + Othr: + Id: 123 + SchmeNm: + Cd: CUST + Prtry: 1 + PersonIdentificationSchemeName1Choice: + title: PersonIdentificationSchemeName1Choice + description: | + Sets of elements to identify a name of the identification scheme. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalPersonIdentification1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CCPT + PhoneNumber: + title: PhoneNumber + type: string + description: | + Double check this regex. + pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$ + PostalAddress24: + title: PostalAddress24 + type: object + description: > + Information that locates and identifies a specific address, as defined + by postal services. + properties: + AdrTp: + $ref: "#/components/schemas/AddressType3Choice" + Dept: + $ref: "#/components/schemas/Max70Text" + SubDept: + $ref: "#/components/schemas/Max70Text" + StrtNm: + $ref: "#/components/schemas/Max70Text" + BldgNb: + $ref: "#/components/schemas/Max16Text" + BldgNm: + $ref: "#/components/schemas/Max35Text" + Flr: + $ref: "#/components/schemas/Max70Text" + PstBx: + $ref: "#/components/schemas/Max16Text" + Room: + $ref: "#/components/schemas/Max70Text" + PstCd: + $ref: "#/components/schemas/Max16Text" + TwnNm: + $ref: "#/components/schemas/Max35Text" + TwnLctnNm: + $ref: "#/components/schemas/Max35Text" + DstrctNm: + $ref: "#/components/schemas/Max35Text" + CtrySubDvsn: + $ref: "#/components/schemas/Max35Text" + Ctry: + $ref: "#/components/schemas/CountryCode" + AdrLine: + $ref: "#/components/schemas/Max70Text" + example: + AdrTp: ADDR + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + BldgNm: BldgNm + Flr: Flr + PstBx: PstBx + Room: Room + PstCd: PstCd + TwnNm: TwnNm + TwnLctnNm: TwnLctnNm + DstrctNm: DstrctNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + AdrLine: AdrLine + PostalAddress27: + title: PostalAddress27 + type: object + description: > + Information that locates and identifies a specific address, as defined + by postal services. + properties: + AdrTp: + $ref: "#/components/schemas/AddressType3Choice" + CareOf: + $ref: "#/components/schemas/Max140Text" + Dept: + $ref: "#/components/schemas/Max70Text" + SubDept: + $ref: "#/components/schemas/Max70Text" + StrtNm: + $ref: "#/components/schemas/Max140Text" + BldgNb: + $ref: "#/components/schemas/Max16Text" + BldgNm: + $ref: "#/components/schemas/Max140Text" + Flr: + $ref: "#/components/schemas/Max70Text" + UnitNb: + $ref: "#/components/schemas/Max16Text" + PstBx: + $ref: "#/components/schemas/Max16Text" + Room: + $ref: "#/components/schemas/Max70Text" + PstCd: + $ref: "#/components/schemas/Max16Text" + TwnNm: + $ref: "#/components/schemas/Max140Text" + TwnLctnNm: + $ref: "#/components/schemas/Max140Text" + DstrctNm: + $ref: "#/components/schemas/Max140Text" + CtrySubDvsn: + $ref: "#/components/schemas/Max35Text" + Ctry: + $ref: "#/components/schemas/CountryCode" + AdrLine: + $ref: "#/components/schemas/Max70Text" + example: + AdrTp: ADDR + CareOf: CareOf + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + BldgNm: BldgNm + Flr: Flr + UnitNb: UnitNb + PstBx: PstBx + Room: Room + PstCd: PstCd + TwnNm: TwnNm + TwnLctnNm: TwnLctnNm + DstrctNm: DstrctNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + AdrLine: AdrLine + PreferredContactMethod1Code: + title: PreferredContactMethod1Code + description: > + Preferred method used to reach the individual contact within an + organisation. + type: string + enum: + - LETT + - MAIL + - PHON + - FAXX + - CELL + example: CELL + PreferredContactMethod2Code: + title: PreferredContactMethod2Code + description: > + Preferred method used to reach the individual contact within an + organisation. + type: string + enum: + - LETT + - MAIL + - PHON + - FAXX + - CELL + example: MAIL + Priority2Code: + title: Priority2Code + description: > + Indicator of the urgency or order of importance that the instructing + party would like the instructed party to apply to the processing of the + instruction. + type: string + enum: + - HIGH + - NORM + example: HIGH + ProxyAccountIdentification1: + title: ProxyAccountIdentification1 + description: | + Information related to a proxy identification of the account. + type: object + properties: + Tp: + $ref: "#/components/schemas/ProxyAccountType1Choice" + Id: + $ref: "#/components/schemas/Max2048Text" + required: + - Id + example: + Tp: + Cd: IBAN + Id: 123 + ProxyAccountType1Choice: + title: ProxyAccountType1Choice + type: object + description: | + NOTE: Unsure on description. + properties: + Cd: + $ref: "#/components/schemas/ExternalProxyAccountType1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CH03 + Purpose2Choice: + title: Purpose2Choice + description: > + Specifies the underlying reason for the payment transaction. + + Usage: Purpose is used by the end-customers, that is initiating party, + (ultimate) debtor, (ultimate) creditor to provide information concerning + the nature of the payment. Purpose is a content element, which is not + used for processing by any of the agents involved in the payment chain. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalPurpose1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: CH03 + RegulatoryAuthority2: + title: RegulatoryAuthority2 + description: > + Information about an entity requiring the regulatory reporting + information. + type: object + properties: + Nm: + $ref: "#/components/schemas/Max140Text" + Ctry: + $ref: "#/components/schemas/CountryCode" + example: + Nm: Swiss National Bank + Ctry: CH + RegulatoryReporting3: + title: RegulatoryReporting3 + description: | + Information needed due to regulatory and/or statutory requirements. + type: object + properties: + DbtCdtRptgInd: + $ref: "#/components/schemas/RegulatoryReportingType1Code" + Authrty: + $ref: "#/components/schemas/RegulatoryAuthority2" + Dtls: + $ref: "#/components/schemas/StructuredRegulatoryReporting3" + example: + DbtCdtRptgInd: CRED + Authrty: + Nm: Swiss National Bank + Ctry: CH + Dtls: + Cd: A1 + Inf: Mandatory regulatory information + RegulatoryReportingType1Code: + title: RegulatoryReportingType1Code + description: > + Identifies whether the regulatory reporting information applies to the + debit side, to the credit side or to both debit and credit sides of the + transaction. + type: string + enum: + - CRED + - DEBT + - BOTH + example: BOTH + ServiceLevel8Choice: + title: ServiceLevel8Choice + description: | + Details about a service level. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalServiceLevel1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: SEPA + SettlementInstruction15: + title: SettlementInstruction15 + description: | + NOTE: Unsure on description. + type: object + properties: + SttlmMtd: + $ref: "#/components/schemas/SettlementMethod1Code" + PmtTpInf: + $ref: "#/components/schemas/PaymentTypeInformation28" + required: + - SttlmMtd + example: + SttlmMtd: INDA + PmtTpInf: + InstrPrty: NORM + SvcLvl: + Cd: SEPA + LclInstrm: + Cd: CH03 + CtgyPurp: + Cd: SUPP + Cdtr: + Nm: Name + PstlAdr: + AdrTp: ADDR + AdrLine: Address + Ctry: CH + Id: + OrgId: + AnyBIC: BIC + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + CtryOfRes: CH + CtctDtls: + Nm: Name + PhneNb: 123 + EmailAdr: null + SettlementMethod1Code: + title: SettlementMethod1Code + description: | + Specifies the method used to settle the credit transfer instruction. + type: string + enum: + - INDA + - INGA + - COVE + - CLRG + example: CLRG + StatusReason6Choice: + title: StatusReason6Choice + description: | + Unsure on description. + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalStatusReason1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: AGNT + StatusReasonInformation14: + title: StatusReasonInformation14 + description: | + Unsure on description. + type: object + properties: + Orgtr: + $ref: "#/components/schemas/PartyIdentification272" + Rsn: + $ref: "#/components/schemas/StatusReason6Choice" + AddtlInf: + $ref: "#/components/schemas/Max105Text" + example: + Orgtr: + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: SubDepartment + StrtNm: StreetName + BldgNb: BuildingNumber + PstCd: PostCode + TwnNm: TownName + CtrySubDvsn: CountrySubDivision + Ctry: Country + Rsn: + Cd: AGNT + AddtlInf: AdditionalInformation + StructuredRegulatoryReporting3: + title: StructuredRegulatoryReporting3 + description: | + Unsure on description. + type: object + properties: + Tp: + $ref: "#/components/schemas/Max35Text" + Dt: + $ref: "#/components/schemas/ISODate" + Ctry: + $ref: "#/components/schemas/CountryCode" + Cd: + $ref: "#/components/schemas/Max10Text" + Amt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + Inf: + $ref: "#/components/schemas/Max35Text" + example: + Tp: T1 + Dt: "2018-01-01" + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 + SupplementaryData1: + title: SupplementaryData1 + description: > + Additional information that can not be captured in the structured fields + and/or any other specific block. + type: object + properties: + PlcAndNm: + $ref: "#/components/schemas/Max350Text" + Envlp: + $ref: "#/components/schemas/SupplementaryDataEnvelope1" + required: + - Envlp + example: + PlcAndNm: Additional information + Envlp: + Cd: CH03 + Prtry: Additional information + SupplementaryDataEnvelope1: + title: SupplementaryDataEnvelope1 + description: | + Unsure on description. + type: object + TaxAmount3: + title: TaxAmount3 + description: | + Information on the amount of the tax record. + type: object + properties: + Rate: + $ref: "#/components/schemas/PercentageRate" + TaxblBaseAmt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + TtlAmt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + Dtls: + $ref: "#/components/schemas/TaxRecordDetails3" + example: + Rate: 0 + TaxblBaseAmt: + Ccy: EUR + Amt: 0 + TtlAmt: + Ccy: EUR + Amt: 0 + Dtls: + Tp: T1 + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 + TaxAuthorisation1: + title: TaxAuthorisation1 + description: | + Details of an authorised tax paying party. + type: object + properties: + Titl: + $ref: "#/components/schemas/Max35Text" + Nm: + $ref: "#/components/schemas/Max140Text" + example: + Titl: Mr + Nm: John Doe + TaxData1: + title: TaxData1 + description: > + Details about tax paid, or to be paid, to the government in accordance + with the law, including pre-defined parameters such as thresholds and + type of account. + type: object + properties: + Cdtr: + $ref: "#/components/schemas/TaxParty1" + Dbtr: + $ref: "#/components/schemas/TaxParty2" + UltmtDbtr: + $ref: "#/components/schemas/TaxParty2" + AdmstnZone: + $ref: "#/components/schemas/Max35Text" + RefNb: + $ref: "#/components/schemas/Max140Text" + Mtd: + $ref: "#/components/schemas/Max35Text" + TtlTaxblBaseAmt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + TtlTaxAmt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + Dt: + $ref: "#/components/schemas/ISODate" + SeqNb: + $ref: "#/components/schemas/Number" + Rcrd: + $ref: "#/components/schemas/TaxRecord3" + example: + Cdtr: + Titl: Mr + Nm: John Doe + Dbtr: + Titl: Mr + Nm: John Doe + UltmtDbtr: + Titl: Mr + Nm: John Doe + AdmstnZone: CH + RefNb: 12345 + Mtd: A + TtlTaxblBaseAmt: + Ccy: CHF + Amt: 1000 + TtlTaxAmt: + Ccy: CHF + Amt: 100 + Dt: "2018-01-01" + SeqNb: 1 + Rcrd: + Tp: T1 + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 + TaxParty1: + title: TaxParty1 + description: | + Details about the entity involved in the tax paid or to be paid. + type: object + properties: + TaxId: + $ref: "#/components/schemas/Max35Text" + RegnId: + $ref: "#/components/schemas/Max35Text" + TaxTp: + $ref: "#/components/schemas/Max35Text" + example: + TaxId: 123456789 + RegnId: 123456789 + TaxTp: VAT + TaxParty2: + title: TaxParty2 + description: | + Details about the entity involved in the tax paid or to be paid. + type: object + properties: + TaxId: + $ref: "#/components/schemas/Max35Text" + RegnId: + $ref: "#/components/schemas/Max35Text" + TaxTp: + $ref: "#/components/schemas/Max35Text" + Authstn: + $ref: "#/components/schemas/TaxAuthorisation1" + example: + TaxId: 123456789 + RegnId: 123456789 + TaxTp: VAT + Authstn: + Titl: Mr + Nm: John Doe + TaxPeriod3: + title: TaxPeriod3 + description: | + Period of time details related to the tax payment. + type: object + properties: + Yr: + $ref: "#/components/schemas/ISOYear" + Tp: + $ref: "#/components/schemas/TaxRecordPeriod1Code" + FrToDt: + $ref: "#/components/schemas/DatePeriod2" + example: + Yr: 2020 + Tp: MM01 + FrToDt: + FrDt: "2020-01-01" + ToDt: "2020-01-31" + TaxRecord3: + title: TaxRecord3 + description: | + Set of elements used to define the tax record. + type: object + properties: + Tp: + $ref: "#/components/schemas/Max35Text" + Ctgy: + $ref: "#/components/schemas/Max35Text" + CtgyDtls: + $ref: "#/components/schemas/Max35Text" + DbtrSts: + $ref: "#/components/schemas/Max35Text" + CertId: + $ref: "#/components/schemas/Max35Text" + FrmsCd: + $ref: "#/components/schemas/Max35Text" + Prd: + $ref: "#/components/schemas/TaxPeriod3" + TaxAmt: + $ref: "#/components/schemas/TaxAmount3" + AddtlInf: + $ref: "#/components/schemas/Max140Text" + example: + Tp: VAT + Ctgy: A + CtgyDtls: Standard + DbtrSts: Resident + CertId: 123456789 + FrmsCd: 123456789 + Prd: + FrstDay: "2019-01-01" + LastDay: "2019-12-31" + TaxAmt: + Rate: 0.2 + TaxblBaseAmt: 1000 + TtlAmt: 200 + AddtlInf: VAT applicable + TaxRecordDetails3: + title: TaxRecordDetails3 + description: | + Details on the tax period and amount + type: object + properties: + Prd: + $ref: "#/components/schemas/TaxPeriod3" + Amt: + $ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount" + required: + - Amt + example: + Prd: + Yr: 2020 + Tp: MM01 + FrToDt: + FrDt: "2020-01-01" + ToDt: "2020-01-31" + Amt: + Amt: 100 + Ccy: EUR + TaxRecordPeriod1Code: + title: TaxRecordPeriod1Code + description: | + Specifies the period related to the tax payment + + MM01 FirstMonth Tax is related to the second month of the period. + MM02 SecondMonth Tax is related to the first month of the period. + MM03 ThirdMonth Tax is related to the third month of the period. + MM04 FourthMonth Tax is related to the fourth month of the period. + MM05 FifthMonth Tax is related to the fifth month of the period. + MM06 SixthMonth Tax is related to the sixth month of the period. + MM07 SeventhMonth Tax is related to the seventh month of the period. + MM08 EighthMonth Tax is related to the eighth month of the period. + MM09 NinthMonth Tax is related to the ninth month of the period. + MM10 TenthMonth Tax is related to the tenth month of the period. + MM11 EleventhMonth Tax is related to the eleventh month of the period. + MM12 TwelfthMonth Tax is related to the twelfth month of the period. + QTR1 FirstQuarter Tax is related to the first quarter of the period. + QTR2 SecondQuarter Tax is related to the second quarter of the period. + QTR3 ThirdQuarter Tax is related to the third quarter of the period. + QTR4 FourthQuarter Tax is related to the forth quarter of the period. + HLF1 FirstHalf Tax is related to the first half of the period. + HLF2 SecondHalf Tax is related to the second half of the period. + type: string + enum: + - MM01 + - MM02 + - MM03 + - MM04 + - MM05 + - MM06 + - MM07 + - MM08 + - MM09 + - MM10 + - MM11 + - MM12 + - QTR1 + - QTR2 + - QTR3 + - QTR4 + - HLF1 + - HLF2 + example: HLF1 + TermsRequest_FIToFICustomerCreditProposal: + title: TermsRequest_FIToFICustomerCreditProposal + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader129" + required: + - GrpHdr + example: + GrpHdr: + MsgId: 123456789 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + CtrlSum: 100 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BBA + Prtry: Party Identification Scheme Name + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + TermsResponse_FIToFICustomerCreditConfirmation: + title: TermsResponse_FIToFICustomerCreditConfirmation + type: object + properties: + GrpHdr: + $ref: "#/components/schemas/GroupHeader129" + CdtTrfTxInf: + $ref: "#/components/schemas/CreditTransferTransaction67" + required: + - GrpHdr + - CdtTrfTxInf + example: + GrpHdr: + MsgId: 123456789 + CreDtTm: "2020-01-01T00:00:00Z" + NbOfTxs: 1 + CtrlSum: 100 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BBA + Prtry: Party Identification Scheme Name + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + UUIDv4Identifier: + title: UUIDv4Identifier + type: string + pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ + example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e + VerificationReason1Choice: + title: VerificationReason1Choice + type: object + properties: + Cd: + $ref: "#/components/schemas/ExternalVerificationReason1Code" + Prtry: + $ref: "#/components/schemas/Max35Text" + oneOf: + - required: + - Cd + - required: + - Prtry + example: + Cd: AGNT + VerificationReport4: + title: VerificationReport4 + type: object + properties: + OrgnlId: + $ref: "#/components/schemas/Max35Text" + Vrfctn: + $ref: "#/components/schemas/IdentificationVerificationIndicator" + Rsn: + $ref: "#/components/schemas/VerificationReason1Choice" + OrgnlPtyAndAcctId: + $ref: "#/components/schemas/IdentificationInformation4" + UpdtdPtyAndAcctId: + $ref: "#/components/schemas/IdentificationInformation4" + required: + - OrgnlId + - Vrfctn + example: + OrgnlId: 123456789 + Vrfctn: true + Rsn: + Cd: AGNT + OrgnlPtyAndAcctId: + Id: 123456789 + SchmeNm: + Cd: CCPT + UpdtdPtyAndAcctId: + Id: 123456789 + SchmeNm: + Cd: CCPT + hexBinary: + title: hexBinary + type: string + pattern: ^(0x|0X)?[a-fA-F0-9]+$ + example: 4660 diff --git a/docs/index.html b/docs/index.html index f1121a54..518e46a3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -43,6 +43,7 @@ {url: "fspiop-rest-v1.0-openapi3-snippets.yaml", name: "v1.0"}, {url: "fspiop-rest-v1.1-openapi3-snippets.yaml", name: "v1.1"}, {url: "fspiop-rest-v2.0-openapi3-snippets.yaml", name: "v2.0"}, + {url: "fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml", name: "v2.0_ISO20022"}, {url: "thirdparty-openapi3-snippets.yaml", name: "thirdparty"}, {url: "sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml", name: "SDK Backend v2.0.0"}, {url: "sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml", name: "SDK Outbound v2.0.0"}, diff --git a/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml b/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml new file mode 100644 index 00000000..2090a7a9 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml @@ -0,0 +1,9 @@ +required: false +schema: + type: integer +description: >- + The `Content-Length` header field indicates the anticipated size of the + payload body. Only sent if there is a body. + + + **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). diff --git a/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml b/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml new file mode 100644 index 00000000..33f23902 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml @@ -0,0 +1,6 @@ +schema: + type: string +required: true +description: >- + The `Content-Type` header indicates the specific version of the API used to + send the payload body. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml new file mode 100644 index 00000000..ecdaf8ee --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml @@ -0,0 +1,8 @@ +name: Accept +in: header +required: true +schema: + type: string +description: >- + The `Accept` header field indicates the version of the API the client would + like the server to use. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml new file mode 100644 index 00000000..a717f344 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml @@ -0,0 +1,11 @@ +name: Content-Length +in: header +required: false +schema: + type: integer +description: >- + The `Content-Length` header field indicates the anticipated size of the + payload body. Only sent if there is a body. + + + **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml new file mode 100644 index 00000000..0c0dd5d8 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml @@ -0,0 +1,8 @@ +name: Content-Type +in: header +schema: + type: string +required: true +description: >- + The `Content-Type` header indicates the specific version of the API used to + send the payload body. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml new file mode 100644 index 00000000..6e199368 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml @@ -0,0 +1,6 @@ +name: Date +in: header +schema: + type: string +required: true +description: The `Date` header field indicates the date when the request was sent. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml new file mode 100644 index 00000000..c1062018 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml @@ -0,0 +1,13 @@ +name: FSPIOP-Destination +in: header +schema: + type: string +required: false +description: >- + The `FSPIOP-Destination` header field is a non-HTTP standard field used by the + API for HTTP header based routing of requests and responses to the + destination. The field must be set by the original sender of the request if + the destination is known (valid for all services except GET /parties) so that + any entities between the client and the server do not need to parse the + payload for routing purposes. If the destination is not known (valid for + service GET /parties), the field should be left empty. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml new file mode 100644 index 00000000..ed0270f4 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml @@ -0,0 +1,8 @@ +name: FSPIOP-Encryption +in: header +schema: + type: string +required: false +description: >- + The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the + API for applying end-to-end encryption of the request. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml new file mode 100644 index 00000000..b6424d9c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml @@ -0,0 +1,11 @@ +name: FSPIOP-HTTP-Method +in: header +schema: + type: string +required: false +description: >- + The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the + API for signature verification, should contain the service HTTP method. + Required if signature verification is used, for more information, see [the API + Signature + document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml new file mode 100644 index 00000000..7b5a6732 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml @@ -0,0 +1,8 @@ +name: FSPIOP-Signature +in: header +schema: + type: string +required: false +description: >- + The `FSPIOP-Signature` header field is a non-HTTP standard field used by the + API for applying an end-to-end request signature. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml new file mode 100644 index 00000000..d3c80829 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml @@ -0,0 +1,10 @@ +name: FSPIOP-Source +in: header +schema: + type: string +required: true +description: >- + The `FSPIOP-Source` header field is a non-HTTP standard field used by the API + for identifying the sender of the HTTP request. The field should be set by the + original sender of the request. Required for routing and signature + verification (see header field `FSPIOP-Signature`). diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml new file mode 100644 index 00000000..8fe8891f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml @@ -0,0 +1,10 @@ +name: FSPIOP-URI +in: header +schema: + type: string +required: false +description: >- + The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for + signature verification, should contain the service URI. Required if signature + verification is used, for more information, see [the API Signature + document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml new file mode 100644 index 00000000..820dc8df --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml @@ -0,0 +1,6 @@ +name: ID +in: path +required: true +schema: + type: string +description: The identifier value. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml new file mode 100644 index 00000000..97f6a86f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml @@ -0,0 +1,8 @@ +name: SubId +in: path +required: true +schema: + type: string +description: >- + A sub-identifier of the party identifier, or a sub-type of the party + identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml new file mode 100644 index 00000000..bc6ae5b4 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml @@ -0,0 +1,6 @@ +name: Type +in: path +required: true +schema: + type: string +description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml b/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml new file mode 100644 index 00000000..442d4d76 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml @@ -0,0 +1,15 @@ +name: X-Forwarded-For +in: header +schema: + type: string +required: false +description: >- + The `X-Forwarded-For` header field is an unofficially accepted standard used + for informational purposes of the originating client IP address, as a request + might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` + values should be expected and supported by implementers of the API. + + + **Note:** An alternative to `X-Forwarded-For` is defined in [RFC + 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is + less-used and supported than `X-Forwarded-For`. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml new file mode 100644 index 00000000..76253e62 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml @@ -0,0 +1 @@ +description: OK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml new file mode 100644 index 00000000..3dae42fc --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml @@ -0,0 +1 @@ +description: Accepted diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml new file mode 100644 index 00000000..7ddf5398 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml @@ -0,0 +1,10 @@ +description: Bad Request +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml new file mode 100644 index 00000000..59039c74 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml @@ -0,0 +1,10 @@ +description: Unauthorized +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml new file mode 100644 index 00000000..55dd0a7c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml @@ -0,0 +1,10 @@ +description: Forbidden +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml new file mode 100644 index 00000000..69db6c6d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml @@ -0,0 +1,10 @@ +description: Not Found +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml new file mode 100644 index 00000000..b87e21d0 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml @@ -0,0 +1,10 @@ +description: Method Not Allowed +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml new file mode 100644 index 00000000..f816b38c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml @@ -0,0 +1,10 @@ +description: Not Acceptable +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml new file mode 100644 index 00000000..f6344893 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml @@ -0,0 +1,10 @@ +description: Not Implemented +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml b/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml new file mode 100644 index 00000000..680fb6c8 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml @@ -0,0 +1,10 @@ +description: Service Unavailable +content: + application/json: + schema: + $ref: ../schemas/ErrorInformationResponse.yaml +headers: + Content-Length: + $ref: ../headers/Content-Length.yaml + Content-Type: + $ref: ../headers/Content-Type.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml new file mode 100644 index 00000000..3015133d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml @@ -0,0 +1,17 @@ +title: AccountIdentification4Choice +type: object +description: > + Specifies the unique identification of an account as assigned by the account + servicer. +properties: + IBAN: + $ref: ./IBAN2007Identifier.yaml + Othr: + $ref: ./GenericAccountIdentification1.yaml +oneOf: + - required: + - IBAN + - required: + - Othr +example: + IBAN: BE71096123456769 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml new file mode 100644 index 00000000..1b53d239 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml @@ -0,0 +1,16 @@ +title: AccountSchemeName1Choice +type: object +description: | + Sets of elements to identify a name of the identification scheme. +properties: + Cd: + $ref: ./ExternalAccountIdentification1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: 1111 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml new file mode 100644 index 00000000..fedf385f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml @@ -0,0 +1,16 @@ +title: ActiveCurrencyAndAmount +type: object +description: > + A number of monetary units specified in an active currency where the + unit of currency is explicit and compliant with ISO 4217. +properties: + ActiveCurrencyAndAmount: + $ref: ./ActiveCurrencyAndAmount_SimpleType.yaml + Ccy: + $ref: ./ActiveCurrencyCode.yaml +required: + - ActiveCurrencyAndAmount + - Ccy +example: + ActiveCurrencyAndAmount: 123.45 + Ccy: USD diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml new file mode 100644 index 00000000..6e0f4f27 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml @@ -0,0 +1,13 @@ +title: ActiveCurrencyAndAmount_SimpleType +type: string +description: | + NOTE: This regex doesn't seem correct given it's xsd definition. + + + + + + + +pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ +example: 123.45 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml new file mode 100644 index 00000000..a91a07d7 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml @@ -0,0 +1,8 @@ +title: ActiveCurrencyCode +type: string +pattern: ^[A-Z]{3,3}$ +description: >- + A code allocated to a currency by a Maintenance Agency under an international + identification scheme as described in the latest edition of the international standard ISO + 4217 "Codes for the representation of currencies and funds". +example: USD diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml new file mode 100644 index 00000000..1d5e5b83 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml @@ -0,0 +1,16 @@ +title: ActiveOrHistoricCurrencyAndAmount +type: object +description: > + A number of monetary units specified in an active or a historic currency where + the unit of currency is explicit and compliant with ISO 4217. +properties: + ActiveOrHistoricCurrencyAndAmount: + $ref: ./ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml + Ccy: + $ref: ./ActiveOrHistoricCurrencyCode.yaml +required: + - ActiveOrHistoricCurrencyAndAmount + - Ccy +example: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml new file mode 100644 index 00000000..b14ec0cf --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml @@ -0,0 +1,4 @@ +title: ActiveOrHistoricCurrencyAndAmount_SimpleType +type: string +pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$ +example: 123.45 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml new file mode 100644 index 00000000..b12118fd --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml @@ -0,0 +1,8 @@ +title: ActiveOrHistoricCurrencyCode +type: string +description: > + A code allocated to a currency by a Maintenance Agency under an international + identification scheme, as described in the latest edition of the international standard ISO + 4217 "Codes for the representation of currencies and funds". +pattern: ^[A-Z]{3,3}$ +example: USD diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml new file mode 100644 index 00000000..3305c93f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml @@ -0,0 +1,12 @@ +description: | + AddressType2Code + Specifies the type of address. +enum: + - ADDR + - PBOX + - HOME + - BIZZ + - MLTO + - DLVY +type: string +example: ADDR diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml new file mode 100644 index 00000000..344d0c9d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml @@ -0,0 +1,16 @@ +title: AddressType3Choice +type: object +description: | + Choice of formats for the type of address. +properties: + Cd: + $ref: ./AddressType2Code.yaml + Prtry: + $ref: ./GenericIdentification30.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: ADDR diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml new file mode 100644 index 00000000..f7281a81 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml @@ -0,0 +1,12 @@ +title: AnyBICDec2014Identifier +type: string +description: > + AnyBICDec2014Identifier + + Code allocated to a financial or non-financial institution by the + + ISO 9362 Registration Authority, as described in ISO 9362: 2014 + + - "Banking - Banking telecommunication messages - Business identifier code (BIC)". +pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ +example: J5BMVH7D diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml new file mode 100644 index 00000000..4e01dc19 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml @@ -0,0 +1,10 @@ +title: BICFIDec2014Identifier +type: string +description: | + Code allocated to a financial institution by the ISO 9362 Registration + + Authority as described in ISO 9362: 2014 + + - "Banking - Banking telecommunication messages - Business identifier code (BIC)". +pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$ +example: J5BMVH7D diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml new file mode 100644 index 00000000..3b00c267 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml @@ -0,0 +1,6 @@ +title: BaseOneRate +type: string +description: | + Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. +pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ +example: 0.7 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml new file mode 100644 index 00000000..4d1df16a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml @@ -0,0 +1,29 @@ +title: BranchAndFinancialInstitutionIdentification6 +type: object +description: > + Unique and unambiguous identification of a financial institution or a branch + of a financial institution. +properties: + FinInstnId: + $ref: ./FinancialInstitutionIdentification18.yaml + BrnchId: + $ref: ./BranchData3.yaml +required: + - FinInstnId +example: + FinInstnId: + BICFI: J5BMVH7D + BrnchId: + Id: 123 + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: Sub department + StrtNm: Street name + BldgNb: Building number + PstCd: Post code + TwnNm: Town name + CtrySubDvsn: Country subdivision + Ctry: Country + AdrLine: Address line diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml new file mode 100644 index 00000000..4b249bbf --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml @@ -0,0 +1,24 @@ +title: BranchAndFinancialInstitutionIdentification8 +type: object +description: > + Unique and unambiguous identification of a financial institution or a branch + of a financial institution. +properties: + FinInstnId: + $ref: ./FinancialInstitutionIdentification23.yaml + BrnchId: + $ref: ./BranchData5.yaml +required: + - FinInstnId +example: + FinInstnId: + BICFI: BUKBGB22 + BrnchId: + Id: 12345 + Nm: Oxford Street Branch + PstlAdr: + Ctry: GB + AdrLine: + - 1 Oxford Street + - London + - UK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml new file mode 100644 index 00000000..c09eb8c9 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml @@ -0,0 +1,28 @@ +title: BranchData3 +type: object +description: > + Information that locates and identifies a specific branch of a financial + institution. +properties: + Id: + $ref: ./Max35Text.yaml + LEI: + $ref: ./LEIIdentifier.yaml + Nm: + $ref: ./Max140Text.yaml + PstlAdr: + $ref: ./PostalAddress24.yaml +example: + Id: 123 + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: Sub department + StrtNm: Street name + BldgNb: Building number + PstCd: Post code + TwnNm: Town name + CtrySubDvsn: Country subdivision + Ctry: Country + AdrLine: Address line diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml new file mode 100644 index 00000000..883ae5b4 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml @@ -0,0 +1,23 @@ +title: BranchData5 +description: > + Information that locates and identifies a specific branch of a financial + institution. +type: object +properties: + Id: + $ref: ./Max35Text.yaml + LEI: + $ref: ./LEIIdentifier.yaml + Nm: + $ref: ./Max140Text.yaml + PstlAdr: + $ref: ./PostalAddress27.yaml +example: + Id: 123 + Nm: Oxford Street Branch + PstlAdr: + Ctry: GB + AdrLine: + - 1 Oxford Street + - London + - UK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml new file mode 100644 index 00000000..d166b13f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml @@ -0,0 +1,24 @@ +title: CashAccount40 +type: object +description: | + Provides the details to identify an account. +properties: + Id: + $ref: ./AccountIdentification4Choice.yaml + Tp: + $ref: ./CashAccountType2Choice.yaml + Ccy: + $ref: ./ActiveOrHistoricCurrencyCode.yaml + Nm: + $ref: ./Max70Text.yaml + Prxy: + $ref: ./ProxyAccountIdentification1.yaml +example: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + Prxy: + Id: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml new file mode 100644 index 00000000..32104888 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml @@ -0,0 +1,16 @@ +title: CashAccountType2Choice +description: | + Specifies the nature, or use of the account. +type: object +properties: + Cd: + $ref: ./ExternalCashAccountType1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CACC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml new file mode 100644 index 00000000..a2d5c8ec --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml @@ -0,0 +1,17 @@ +title: CategoryPurpose1Choice +description: > + Contains details about high level purpose of the mandate based on a set of + pre-defined categories. +type: object +properties: + Cd: + $ref: ./ExternalCategoryPurpose1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CASH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml new file mode 100644 index 00000000..f7e9ca1c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml @@ -0,0 +1,23 @@ +title: ChargeBearerType1Code +description: > + Specifies which party(ies) will pay charges due for processing of the + instruction. + + DEBT BorneByDebtor All transaction charges are to be borne by the debtor. + + CRED BorneByCreditor All transaction charges are to be borne by the creditor. + + SHAR Shared In a credit transfer context, means that transaction charges on + the sender side are to be borne by the debtor, transaction charges on the receiver side are to + be borne by the creditor. In a direct debit context, means that transaction charges on the sender side + are to be borne by the creditor, transaction charges on the receiver + + SLEV FollowingServiceLevel Charges are to be applied following the rules + agreed in the service level. +type: string +enum: + - DEBT + - CRED + - SHAR + - SLEV +example: DEBT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml new file mode 100644 index 00000000..f5bf9eab --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml @@ -0,0 +1,15 @@ +title: ChargeType3Choice +description: ChargeType3Choice Specifies the type of charge. +type: object +properties: + Cd: + $ref: ./ExternalChargeType1Code.yaml + Prtry: + $ref: ./GenericIdentification3.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CASH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml new file mode 100644 index 00000000..7225fc04 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml @@ -0,0 +1,25 @@ +title: Charges16 +description: | + NOTE: Unsure on description. +type: object +properties: + Amt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + Agt: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + Tp: + $ref: ./ChargeType3Choice.yaml +required: + - Amt + - Agt +example: + Amt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + Agt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Tp: + Cd: SHAR diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml new file mode 100644 index 00000000..1f7115ff --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml @@ -0,0 +1,22 @@ +title: ClearingChannel2Code +description: > + Specifies the clearing channel for the routing of the transaction, as part of + the payment type identification. + + RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross + settlement system. + + RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net + settlement system. + + MPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement + system. + + BOOK BookTransfer Payment through internal book transfer. +type: string +enum: + - RTGS + - RTNS + - MPNS + - BOOK +example: RTGS diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml new file mode 100644 index 00000000..66e19cf2 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml @@ -0,0 +1,16 @@ +title: ClearingSystemIdentification2Choice +description: | + Choice of a clearing system identifier. +type: object +properties: + Cd: + $ref: ./ExternalClearingSystemIdentification1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CHQB diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml new file mode 100644 index 00000000..fe7af25d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml @@ -0,0 +1,16 @@ +title: ClearingSystemMemberIdentification2 +description: > + Unique identification, as assigned by a clearing system, to unambiguously + identify a member of the clearing system. +type: object +properties: + ClrSysId: + $ref: ./ClearingSystemIdentification2Choice.yaml + MmbId: + $ref: ./Max35Text.yaml +required: + - MmbId +example: + ClrSysId: + Cd: CHQB + MmbId: 123456789 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml new file mode 100644 index 00000000..7c9383c8 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml @@ -0,0 +1,39 @@ +title: Contact13 +description: | + Specifies the details of the contact person. +type: object +properties: + NmPrfx: + $ref: ./NamePrefix2Code.yaml + Nm: + $ref: ./Max140Text.yaml + PhneNb: + $ref: ./PhoneNumber.yaml + MobNb: + $ref: ./PhoneNumber.yaml + FaxNb: + $ref: ./PhoneNumber.yaml + URLAdr: + $ref: ./Max2048Text.yaml + EmailAdr: + $ref: ./Max256Text.yaml + EmailPurp: + $ref: ./Max35Text.yaml + JobTitl: + $ref: ./Max35Text.yaml + Rspnsblty: + $ref: ./Max35Text.yaml + Dept: + $ref: ./Max70Text.yaml + Othr: + $ref: ./OtherContact1.yaml + PrefrdMtd: + $ref: ./PreferredContactMethod2Code.yaml +example: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + URLAdr: http://www.example.com + EmailAdr: example@example.com diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml new file mode 100644 index 00000000..14e7922d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml @@ -0,0 +1,36 @@ +title: Contact4 +description: | + Specifies the details of the contact person. +type: object +properties: + NmPrfx: + $ref: ./NamePrefix2Code.yaml + Nm: + $ref: ./Max140Text.yaml + PhneNb: + $ref: ./PhoneNumber.yaml + MobNb: + $ref: ./PhoneNumber.yaml + FaxNb: + $ref: ./PhoneNumber.yaml + EmailAdr: + $ref: ./Max2048Text.yaml + EmailPurp: + $ref: ./Max35Text.yaml + JobTitl: + $ref: ./Max35Text.yaml + Rspnsblty: + $ref: ./Max35Text.yaml + Dept: + $ref: ./Max70Text.yaml + Othr: + $ref: ./OtherContact1.yaml + PrefrdMtd: + $ref: ./PreferredContactMethod1Code.yaml +example: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: example@example.com diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml new file mode 100644 index 00000000..bff85d31 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml @@ -0,0 +1,4 @@ +title: CountryCode +type: string +pattern: ^[A-Z]{2,2}$ +example: US diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml new file mode 100644 index 00000000..03b7fc29 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml @@ -0,0 +1,125 @@ +title: CreditTransferTransaction67 +description: > + Provides further details specific to the individual transaction(s) included in + the message. +type: object +properties: + PmtId: + $ref: ./PaymentIdentification13.yaml + PmtTpInf: + $ref: ./PaymentTypeInformation28.yaml + IntrBkSttlmAmt: + $ref: ./ActiveCurrencyAndAmount.yaml + InstdAmt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + XchgRate: + $ref: ./BaseOneRate.yaml + ChrgBr: + $ref: ./ChargeBearerType1Code.yaml + ChrgsInf: + $ref: ./Charges16.yaml + Dbtr: + $ref: ./PartyIdentification272.yaml + DbtrAcct: + $ref: ./CashAccount40.yaml + DbtrAgt: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + CdtrAgt: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + Cdtr: + $ref: ./PartyIdentification272.yaml + CdtrAcct: + $ref: ./CashAccount40.yaml + InstrForCdtrAgt: + $ref: ./InstructionForCreditorAgent3.yaml + InstrForNxtAgt: + $ref: ./InstructionForNextAgent1.yaml + Purp: + $ref: ./Purpose2Choice.yaml + RgltryRptg: + $ref: ./RegulatoryReporting3.yaml + Tax: + $ref: ./TaxData1.yaml + VrfctnOfTerms: + $ref: ./CryptographicLockChoice.yaml +required: + - PmtId + - IntrBkSttlmAmt + - ChrgBr + - Dbtr + - DbtrAgt + - CdtrAgt + - Cdtr +example: + PmtId: + InstrId: INSTRID + EndToEndId: ENDTOENDID + PmtTpInf: + LclInstrm: + Cd: CHQB + Prtry: PROPRIETARY + SeqTp: SEQTP + IntrBkSttlmAmt: + ActiveCurrencyAndAmount: 123.45 + Ccy: USD + InstdAmt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + XchgRate: 123.45 + ChrgBr: SHAR + ChrgsInf: + Amt: + ActiveOrHistoricCurrencyAndAmount: 123.45 + Ccy: USD + Agt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Tp: + Cd: SHAR + Dbtr: + Nm: NAME + PstlAdr: + AdrTp: ADDR + BldgNb: BLDGNB + Ctry: CTRY + TwnNm: TWNNM + PstCd: PSTCD + StrtNm: STRTNM + DbtrAcct: + Id: + IBAN: IBAN + DbtrAgt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + CdtrAgt: + BrnchId: + Id: BRANCHID + FinInstnId: + BICFI: BICFI + Cdtr: + Nm: NAME + PstlAdr: + AdrTp: ADDR + BldgNb: BLDGNB + Ctry: CTRY + TwnNm: TWNNM + PstCd: PSTCD + StrtNm: STRTNM + CdtrAcct: + Id: + IBAN: IBAN + InstrForCdtrAgt: + Cd: CODE + InstrForNxtAgt: + Cd: CODE + Purp: + Cd: CASH + RgltryRptg: + Dbtr: TRUE + Cdtr: TRUE + Tax: + Cdtr diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml new file mode 100644 index 00000000..972fa13b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml @@ -0,0 +1,69 @@ +title: CreditTransferTransaction68 +description: > + Provides further details specific to the individual transaction(s) included in + the message. +type: object +properties: + PmtId: + $ref: ./PaymentIdentification13.yaml + PmtTpInf: + $ref: ./PaymentTypeInformation28.yaml + IntrBkSttlmAmt: + $ref: ./ActiveCurrencyAndAmount.yaml + Dbtr: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + DbtrAcct: + $ref: ./CashAccount40.yaml + DbtrAgt: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + CdtrAgt: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + Cdtr: + $ref: ./BranchAndFinancialInstitutionIdentification8.yaml + CdtrAcct: + $ref: ./CashAccount40.yaml + InstrForCdtrAgt: + $ref: ./InstructionForCreditorAgent3.yaml + Purp: + $ref: ./Purpose2Choice.yaml + VrfctnOfTerms: + $ref: ./CryptographicLockChoice.yaml +required: + - PmtId + - IntrBkSttlmAmt + - Dbtr + - Cdtr +example: + PmtId: + InstrId: INSTRID + EndToEndId: ENDTOENDID + PmtTpInf: + LclInstrm: + Cd: CHQB + Prtry: PROPRIETARY + IntrBkSttlmAmt: + Amount: 123.45 + Ccy: EUR + Dbtr: + Nm: Debtor Name + DbtrAcct: + Id: + IBAN: IBAN + DbtrAgt: + FinInstnId: + BICFI: BICFI + CdtrAgt: + FinInstnId: + BICFI: BICFI + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: IBAN + InstrForCdtrAgt: + Cd: INSTRUCTION + Purp: + Cd: CHAR + VrfctnOfTerms: + Cntt: CONTENT + CnttTp: PROPRIETARY diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml new file mode 100644 index 00000000..87723d24 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml @@ -0,0 +1,16 @@ +title: CryptographicLockChoice +description: | + NOTE: Unsure on description. +type: object +properties: + IlpV4PrepPacket: + $ref: ./hexBinary.yaml + Sh256Sgntr: + $ref: ./Exact32HexBinaryText.yaml +oneOf: + - required: + - IlpV4PrepPacket + - required: + - Sh256Sgntr +example: + IlpV4PrepPacket: 1234567890ABCDEF diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml new file mode 100644 index 00000000..47b11a61 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml @@ -0,0 +1,22 @@ +title: DateAndPlaceOfBirth1 +description: | + Details about date and place of birth of a person. +type: object +properties: + BirthDt: + $ref: ./ISODate.yaml + PrvcOfBirth: + $ref: ./Max35Text.yaml + CityOfBirth: + $ref: ./Max35Text.yaml + CtryOfBirth: + $ref: ./CountryCode.yaml +required: + - BirthDt + - CityOfBirth + - CtryOfBirth +example: + BirthDt: 1970-01-01 + PrvcOfBirth: ON + CityOfBirth: Ottawa + CtryOfBirth: CA diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml new file mode 100644 index 00000000..2bb6d9f9 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml @@ -0,0 +1,15 @@ +title: DatePeriod2 +description: | + Range of time defined by a start date and an end date. +type: object +properties: + FrDt: + $ref: ./ISODate.yaml + ToDt: + $ref: ./ISODate.yaml +required: + - FrDt + - ToDt +example: + FrDt: 2020-01-01 + ToDt: 2020-12-31 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml new file mode 100644 index 00000000..09dc367e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml @@ -0,0 +1,11 @@ +title: ErrorCode +type: string +pattern: ^[1-9]\d{3}$ +description: >- + The API data type ErrorCode is a JSON String of four characters, consisting of + digits only. Negative numbers are not allowed. A leading zero is not allowed. + Each error code in the API is a four-digit number, for example, 1234, where + the first number (1 in the example) represents the high-level error category, + the second number (2 in the example) represents the low-level error category, + and the last two numbers (34 in the example) represent the specific error. +example: '5100' diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml new file mode 100644 index 00000000..76296032 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml @@ -0,0 +1,5 @@ +title: ErrorDescription +type: string +minLength: 1 +maxLength: 128 +description: Error description string. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml new file mode 100644 index 00000000..444377e0 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml @@ -0,0 +1,13 @@ +title: ErrorInformation +type: object +description: Data model for the complex type ErrorInformation. +properties: + errorCode: + $ref: ./ErrorCode.yaml + errorDescription: + $ref: ./ErrorDescription.yaml + extensionList: + $ref: ./ExtensionList.yaml +required: + - errorCode + - errorDescription diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml new file mode 100644 index 00000000..30858953 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml @@ -0,0 +1,8 @@ +title: ErrorInformationResponse +type: object +description: > + Data model for the complex type object that contains an optional element + ErrorInformation used along with 4xx and 5xx responses. +properties: + errorInformation: + $ref: ./ErrorInformation.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml new file mode 100644 index 00000000..a31d3039 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml @@ -0,0 +1,6 @@ +title: Exact32HexBinaryText +description: | + Specifies a hexadecimal string with a length of 32 characters. +type: string +pattern: ^([0-9A-F][0-9A-F]){32}$ +example: 1234567890ABCDEF1234567890ABCDEF diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml new file mode 100644 index 00000000..d61c6ac2 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml @@ -0,0 +1,6 @@ +title: Exact4AlphaNumericText +description: | + Specifies an alphanumeric string with a length of 4 characters. +type: string +pattern: ^[a-zA-Z0-9]{4}$ +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml new file mode 100644 index 00000000..76396061 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml @@ -0,0 +1,61 @@ +title: Execute_FIToFICustomerCreditTransferV13 +type: object +properties: + GrpHdr: + $ref: ./GroupHeader129.yaml + CdtTrfTxInf: + $ref: ./CreditTransferTransaction67.yaml +required: + - GrpHdr + - CdtTrfTxInf +example: + GrpHdr: + MsgId: 123456789 + CreDtTm: 2020-01-01T00:00:00Z + NbOfTxs: 1 + CtrlSum: 100.00 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: 91 + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + CdtTrfTxInf: + PmtId: + InstrId: 123456789 + EndToEndId: 123456789 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: + Cd: SUPP + InstrForCdtrAgt: + FinInstnId: + BICFI: AAAAAAAA + CdtrAgt: + FinInstnId: + BICFI: AAAAAAAA + Cdtr: + Nm: Creditor Name + PstlAdr: + AdrLine: + - Creditor Address Line 1 + - Creditor Address Line 2 + - Creditor Address Line 3 + - Creditor Address Line 4 + - Creditor Address Line 5 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: 91 + CdtrAcct: + Id: + IBAN: DE87123456781234567890 + RmtInf: + Ustrd: Remittance Information diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml new file mode 100644 index 00000000..c4405431 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml @@ -0,0 +1,11 @@ +title: Extension +type: object +description: Data model for the complex type Extension. +properties: + key: + $ref: ./ExtensionKey.yaml + value: + $ref: ./ExtensionValue.yaml +required: + - key + - value diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml new file mode 100644 index 00000000..d5aaaf1b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml @@ -0,0 +1,5 @@ +title: ExtensionKey +type: string +minLength: 1 +maxLength: 32 +description: Extension key. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml new file mode 100644 index 00000000..5539d7d1 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml @@ -0,0 +1,15 @@ +title: ExtensionList +type: object +description: > + Data model for the complex type ExtensionList. An optional list of extensions, + specific to deployment. +properties: + extension: + type: array + items: + $ref: ./Extension.yaml + minItems: 1 + maxItems: 16 + description: Number of Extension elements. +required: + - extension diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml new file mode 100644 index 00000000..858f8551 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml @@ -0,0 +1,5 @@ +title: ExtensionValue +type: string +minLength: 1 +maxLength: 128 +description: Extension value. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml new file mode 100644 index 00000000..60bd5124 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml @@ -0,0 +1,8 @@ +title: ExternalAccountIdentification1Code +description: > + Specifies the external account identification scheme name code in the format + of character string with a maximum length of 4 characters. +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml new file mode 100644 index 00000000..199300d9 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml @@ -0,0 +1,8 @@ +title: ExternalCashAccountType1Code +description: > + Specifies the nature, or use, of the cash account in the format of character + string with a maximum length of 4 characters. +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml new file mode 100644 index 00000000..8c1924d2 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml @@ -0,0 +1,9 @@ +description: > + Specifies the category purpose, as published in an external category purpose + code list. + + External code sets can be downloaded from www.iso20022.org. +maxLength: 4 +minLength: 1 +type: string +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml new file mode 100644 index 00000000..15bdfe28 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalChargeType1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml new file mode 100644 index 00000000..f75bdfb8 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalClearingSystemIdentification1Code +type: string +minLength: 1 +maxLength: 5 +example: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml new file mode 100644 index 00000000..fac6fded --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalCreditorAgentInstruction1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml new file mode 100644 index 00000000..0298ff88 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalFinancialInstitutionIdentification1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml new file mode 100644 index 00000000..3f070cb9 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalLocalInstrument1Code +type: string +minLength: 1 +maxLength: 35 +example: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml new file mode 100644 index 00000000..25af3cf1 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalOrganisationIdentification1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml new file mode 100644 index 00000000..29ceda9b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalPaymentTransactionStatus1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml new file mode 100644 index 00000000..4dbaa97d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalPersonIdentification1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml new file mode 100644 index 00000000..2ce7bf77 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalProxyAccountType1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml new file mode 100644 index 00000000..ba9a1cdd --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalPurpose1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml new file mode 100644 index 00000000..ef347616 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalServiceLevel1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml new file mode 100644 index 00000000..987ecbe7 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalStatusReason1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml new file mode 100644 index 00000000..b10499ff --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml @@ -0,0 +1,5 @@ +title: ExternalVerificationReason1Code +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml new file mode 100644 index 00000000..125d1e15 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml @@ -0,0 +1,14 @@ +title: FinancialIdentificationSchemeName1Choice +type: object +properties: + Cd: + $ref: ./ExternalFinancialInstitutionIdentification1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml new file mode 100644 index 00000000..2f6fda2e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml @@ -0,0 +1,24 @@ +title: FinancialInstitutionIdentification18 +type: object +properties: + BICFI: + $ref: ./BICFIDec2014Identifier.yaml + ClrSysMmbId: + $ref: ./ClearingSystemMemberIdentification2.yaml + LEI: + $ref: ./LEIIdentifier.yaml + Nm: + $ref: ./Max140Text.yaml + PstlAdr: + $ref: ./PostalAddress24.yaml + Othr: + $ref: ./GenericFinancialIdentification1.yaml +example: + BICFI: BUKBGB22 + Nm: Barclays Bank Plc + PstlAdr: + Ctry: GB + AdrLine: + - 1 Churchill Place + - London + - UK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml new file mode 100644 index 00000000..ebd7b919 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml @@ -0,0 +1,24 @@ +title: FinancialInstitutionIdentification23 +type: object +properties: + BICFI: + $ref: ./BICFIDec2014Identifier.yaml + ClrSysMmbId: + $ref: ./ClearingSystemMemberIdentification2.yaml + LEI: + $ref: ./LEIIdentifier.yaml + Nm: + $ref: ./Max140Text.yaml + PstlAdr: + $ref: ./PostalAddress27.yaml + Othr: + $ref: ./GenericFinancialIdentification1.yaml +example: + BICFI: BUKBGB22 + Nm: Barclays Bank Plc + PstlAdr: + Ctry: GB + AdrLine: + - 1 Churchill Place + - London + - UK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml new file mode 100644 index 00000000..42ed228a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml @@ -0,0 +1,83 @@ +title: FxRequest_FICreditTransferProposal +type: object +properties: + GrpHdr: + $ref: ./GroupHeader113.yaml +required: + - GrpHdr +example: + GrpHdr: + MsgId: 123456789 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + CtrlSum: 100.00 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + FwdgAgt: + FinInstnId: + BICFI: BICFID0 + Dbtr: + Nm: Debtor Name + PstlAdr: + AdrLine: + - Debtor Address Line 1 + - Debtor Address Line 2 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + DbtrAcct: + Id: + IBAN: BE71096123456769 + DbtrAgt: + FinInstnId: + BICFI: BICFID0 + Cdtr: + Nm: Creditor Name + PstlAdr: + AdrLine: + - Creditor Address Line 1 + - Creditor Address Line 2 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC + CdtrAcct: + Id: + IBAN: BE71096123456769 + CdtrAgt: + FinInstnId: + BICFI: BICFID0 + CdtTrfTxInf: + - PmtId: + InstrId: 123456789 + EndToEndId: 123456789 + Amt: + InstdAmt: + Ccy: EUR + Amt: 100.00 + CdtrAgt: + FinInstnId: + BICFI: BICFID0 + Cdtr: + Nm: Creditor Name + PstlAdr: + AdrLine: + - Creditor Address Line 1 + - Creditor Address Line 2 + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml new file mode 100644 index 00000000..4274890b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml @@ -0,0 +1,81 @@ +title: FxResponse_FICreditTransferConfirmation +type: object +properties: + GrpHdr: + $ref: ./GroupHeader113.yaml + CdtTrfTxInf: + $ref: ./CreditTransferTransaction68.yaml +required: + - GrpHdr + - CdtTrfTxInf +example: + GrpHdr: + MsgId: 20191122-123456 + CreDtTm: '2019-11-22T12:34:56' + NbOfTxs: 1 + CtrlSum: 100.00 + InitgPty: + Nm: Initiating Party Name + MsgRcpt: + Nm: Message Recipient Name + CdtTrfTxInf: + PmtId: + InstrId: 20191122-123456 + EndToEndId: 20191122-123456 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: SUPP + IntrBkSttlmAmt: + Amt: 100.00 + Ccy: EUR + ChrgBr: SLEV + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + CdtrAgt: + FinInstnId: + BICFI: BNBABEBB + CdtrAgtAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + Dbtr: + Nm: Debtor Name + DbtrAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + DbtrAgt: + FinInstnId: + BICFI: BNBABEBB + DbtrAgtAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account + RmtInf: + Ustrd: Remittance Information + RgltryRptg: + Dbtr: + Nm: Debtor Name + DbtrAcct: + Id: + IBAN: BE71096123456769 + Tp: + Cd: CACC + Ccy: EUR + Nm: My account diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml new file mode 100644 index 00000000..05acd993 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml @@ -0,0 +1,57 @@ +title: Fxecute_FinancialInstitutionCreditTransferV12 +type: object +properties: + GrpHdr: + $ref: ./GroupHeader129.yaml + CdtTrfTxInf: + $ref: ./CreditTransferTransaction68.yaml +required: + - GrpHdr + - CdtTrfTxInf +example: + GrpHdr: + MsgId: 20191113001 + CreDtTm: 2019-11-13T10:00:00 + NbOfTxs: 1 + CtrlSum: 1000 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + Id: 123456789 + SchmeNm: + Cd: BBA + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB + DbtrAgt: + FinInstnId: + BICFI: AAAAAAAA + CdtrAgt: + FinInstnId: + BICFI: CCCCCCCC + CdtTrfTxInf: + PmtId: + InstrId: 20191113001 + EndToEndId: 20191113001 + PmtTpInf: + InstrPrty: NORM + CtgyPurp: + Cd: SUPP + InstrForCdtrAgt: + Cd: /ACC/123456789 + IntrBkSttlmAmt: + Amt: 1000 + Ccy: EUR + ChrgBr: SLEV + CdtrAgt: + FinInstnId: + BICFI: CCCCCCCC + Cdtr: + Nm: Creditor Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + RmtInf: + Ustrd: Payment for invoice 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml new file mode 100644 index 00000000..c2691761 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml @@ -0,0 +1,16 @@ +title: GenericAccountIdentification1 +type: object +properties: + Id: + $ref: ./Max34Text.yaml + SchmeNm: + $ref: ./AccountSchemeName1Choice.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml new file mode 100644 index 00000000..1272ccf6 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml @@ -0,0 +1,16 @@ +title: GenericFinancialIdentification1 +type: object +properties: + Id: + $ref: ./Max35Text.yaml + SchmeNm: + $ref: ./FinancialIdentificationSchemeName1Choice.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml new file mode 100644 index 00000000..8471eb88 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml @@ -0,0 +1,12 @@ +title: GenericIdentification3 +type: object +properties: + Id: + $ref: ./Max35Text.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml new file mode 100644 index 00000000..4dbfac1b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml @@ -0,0 +1,16 @@ +title: GenericIdentification30 +type: object +properties: + Id: + $ref: ./Exact4AlphaNumericText.yaml + Issr: + $ref: ./Max35Text.yaml + SchmeNm: + $ref: ./Max35Text.yaml +required: + - Id + - Issr +example: + Id: 1234 + Issr: BIC + SchmeNm: BICFI diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml new file mode 100644 index 00000000..72815459 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml @@ -0,0 +1,16 @@ +title: GenericOrganisationIdentification1 +type: object +properties: + Id: + $ref: ./Max35Text.yaml + SchmeNm: + $ref: ./OrganisationIdentificationSchemeName1Choice.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml new file mode 100644 index 00000000..af5406fc --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml @@ -0,0 +1,16 @@ +title: GenericOrganisationIdentification3 +type: object +properties: + Id: + $ref: ./Max256Text.yaml + SchmeNm: + $ref: ./OrganisationIdentificationSchemeName1Choice.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml new file mode 100644 index 00000000..321fb6bd --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml @@ -0,0 +1,16 @@ +title: GenericPersonIdentification1 +type: object +properties: + Id: + $ref: ./Max35Text.yaml + SchmeNm: + $ref: ./PersonIdentificationSchemeName1Choice.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + SchmeNm: + Cd: DRLC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml new file mode 100644 index 00000000..65f2cf9f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml @@ -0,0 +1,16 @@ +title: GenericPersonIdentification2 +type: object +properties: + Id: + $ref: ./Max256Text.yaml + SchmeNm: + $ref: ./PersonIdentificationSchemeName1Choice.yaml + Issr: + $ref: ./Max35Text.yaml +required: + - Id +example: + Id: 123 + SchmeNm: + Cd: DRLC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml new file mode 100644 index 00000000..bfe2d31b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml @@ -0,0 +1,57 @@ +title: GetPartiesError_IdentificationVerificationReportV03 +type: object +properties: + Assgnmt: + $ref: ./IdentificationAssignment3.yaml + Rpt: + $ref: ./VerificationReport4.yaml + SplmtryData: + $ref: ./SupplementaryData1.yaml +required: + - Assgnmt + - Rpt +example: + Assgnmt: + Id: 123 + CreDtTm: '2013-03-07T16:30:00' + Assgnr: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Assgne: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rpt: + Id: 123 + CreDtTm: '2013-03-07T16:30:00' + RptgPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdDoc: + Nb: 123 + RltdDt: '2013-03-07' + RltdDtTp: + Cd: 123 + Rsn: + Cd: 123 + Prtry: 123 + SplmtryData: + PlcAndNm: 123 + Envlp: 123 + RltdDt: '2013-03-07' + RltdDtTp: + Cd: 123 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml new file mode 100644 index 00000000..7e81e9b1 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml @@ -0,0 +1,57 @@ +title: GetParties_IdentificationVerificationReportV03 +type: object +properties: + Assgnmt: + $ref: ./IdentificationAssignment3.yaml + Rpt: + $ref: ./VerificationReport4.yaml + SplmtryData: + $ref: ./SupplementaryData1.yaml +required: + - Assgnmt + - Rpt +example: + Assgnmt: + Id: 123 + CreDtTm: '2013-03-07T16:30:00' + Assgnr: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Assgne: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rpt: + Id: 123 + CreDtTm: '2013-03-07T16:30:00' + RptgPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdPty: + Id: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + RptdDoc: + Nb: 123 + RltdDt: '2013-03-07' + RltdDtTp: + Cd: 123 + Rsn: + Cd: 123 + Prtry: 123 + SplmtryData: + PlcAndNm: 123 + Envlp: 123 + RltdDt: '2013-03-07' + RltdDtTp: + Cd: 123 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml new file mode 100644 index 00000000..68ac8542 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml @@ -0,0 +1,72 @@ +title: GroupHeader113 +description: > + Set of characteristics shared by all individual transactions included in the + message. +type: object +properties: + MsgId: + $ref: ./Max35Text.yaml + CreDtTm: + $ref: ./ISODateTime.yaml + NbOfTxs: + $ref: ./Max15NumericText.yaml + TtlIntrBkSttlmAmt: + $ref: ./ActiveCurrencyAndAmount.yaml + SttlmInf: + $ref: ./SettlementInstruction15.yaml + PmtTpInf: + $ref: ./PaymentTypeInformation28.yaml + CdtTrfTxInf: + $ref: ./CreditTransferTransaction68.yaml +required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + - CdtTrfTxInf +example: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + TtlIntrBkSttlmAmt: + Ccy: EUR + Value: 100.0 + SttlmInf: + SttlmMtd: INDA + SttlmAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + SttlmAcctOwnr: + Nm: Name + SttlmAcctSvcr: + Nm: Name + SttlmAgt: + FinInstnId: + BICFI: BIC + PmtTpInf: + InstrPrty: NORM + CtgyPurp: CASH + CdtTrfTxInf: + PmtId: + InstrId: 12345 + EndToEndId: 12345 + Amt: + InstdAmt: + Ccy: EUR + Value: 100.0 + Cdtr: + Nm: Name + CdtrAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + CdtrAgt: + FinInstnId: + BICFI: BIC + CdtrAgtAcct: + Id: + IBAN: BE71096123456769 + Ccy: EUR + RmtInf: + Ustrd: Test diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml new file mode 100644 index 00000000..c36d8757 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml @@ -0,0 +1,35 @@ +title: GroupHeader120 +description: > + Set of characteristics shared by all individual transactions included in the + message. +type: object +properties: + MsgId: + $ref: ./Max35Text.yaml + CreDtTm: + $ref: ./ISODateTime.yaml + TxInfAndSts: + $ref: ./PaymentTransaction163.yaml +required: + - MsgId + - CreDtTm +example: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + TxInfAndSts: + StsId: 12345 + OrgnlInstrId: 12345 + OrgnlEndToEndId: 12345 + OrgnlTxId: 12345 + OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000 + TxSts: RJCT + StsRsnInf: + Rsn: RSN + AddtlInf: ADDITIONAL + AccptncDtTm: '2020-01-01T00:00:00Z' + AcctSvcrRef: ACCTSVCRREF + ClrSysRef: CLRSYSREF + ExctnConf: 1234567890ABCDEF + SplmtryData: + PlcAndNm: PLACE + Envlp: ENVELOPE diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml new file mode 100644 index 00000000..e4c0a9b0 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml @@ -0,0 +1,58 @@ +title: GroupHeader129 +description: > + Set of characteristics shared by all individual transactions included in the + message. +type: object +properties: + MsgId: + $ref: ./Max35Text.yaml + CreDtTm: + $ref: ./ISODateTime.yaml + PmtInstrXpryDtTm: + $ref: ./ISODateTime.yaml + NbOfTxs: + $ref: ./Max15NumericText.yaml + SttlmInf: + $ref: ./SettlementInstruction15.yaml + CdtTrfTxInf: + $ref: ./CreditTransferTransaction67.yaml +required: + - MsgId + - CreDtTm + - NbOfTxs + - SttlmInf + - CdtTrfTxInf +example: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + PmtInstrXpryDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: INDA + SttlmAcct: + Id: + IBAN: 123 + SttlmAcctOwnr: + Nm: John Doe + SttlmAcctSvcr: + BICFI: 123 + CdtTrfTxInf: + PmtId: + InstrId: 123 + EndToEndId: 123 + PmtTpInf: + InstrPrty: NORM + InstdAmt: + Amt: 123 + Ccy: EUR + ChrgBr: SLEV + CdtrAgt: + FinInstnId: + BICFI: 123 + Cdtr: + Nm: John Doe + CdtrAcct: + Id: + IBAN: 123 + RmtInf: + Ustrd: Test diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml new file mode 100644 index 00000000..eee632ba --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml @@ -0,0 +1,12 @@ +title: IBAN2007Identifier +description: > + The International Bank Account Number is a code used internationally by + financial institutions to uniquely identify the account of a customer + at a financial institution as described in the 2007 edition of the + ISO 13616 standard "Banking and related financial services - + + International Bank Account Number (IBAN)" and replaced by the more recent + edition of the standard. +type: string +pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$ +example: FR1420041010050500013M02606 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml new file mode 100644 index 00000000..59c67410 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml @@ -0,0 +1,9 @@ +title: ISODate +description: > + A particular point in the progression of time in a calendar year + expressed in the YYYY-MM-DD format. This representation is defined in + "XML Schema Part 2: Datatypes Second Edition - + W3C Recommendation 28 October 2004" which is aligned with ISO 8601. +type: string +format: date +example: '2013-03-07' diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml new file mode 100644 index 00000000..2eac7b39 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml @@ -0,0 +1,21 @@ +title: ISODateTime +description: | + A particular point in the progression of time defined by a mandatory + date and a mandatory time component, expressed in either UTC time + format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format + (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format + (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in + "XML Schema Part 2: Datatypes Second Edition - + W3C Recommendation 28 October 2004" which is aligned with ISO 8601. + + Note on the time format: + 1) beginning / end of calendar day + 00:00:00 = the beginning of a calendar day + 24:00:00 = the end of a calendar day + + 2) fractions of second in time format + Decimal fractions of seconds may be included. In this case, the + involved parties shall agree on the maximum number of digits that are allowed. +type: string +format: datetime +example: '2013-03-07T14:44:30.000Z' diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml new file mode 100644 index 00000000..4d6e2981 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml @@ -0,0 +1,6 @@ +title: ISOYear +description: | + Year represented by YYYY (ISO 8601). +type: string +pattern: ^\d{4}(Z|([+-]\d{2}:\d{2})){0,1}$ +example: 2019 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml new file mode 100644 index 00000000..c77fd8ec --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml @@ -0,0 +1,33 @@ +title: IdentificationAssignment3 +type: object +properties: + MsgId: + $ref: ./Max35Text.yaml + CreDtTm: + $ref: ./ISODateTime.yaml + Assgnr: + $ref: ./Party40Choice.yaml + Assgne: + $ref: ./Party40Choice.yaml +required: + - MsgId + - CreDtTm + - Assgnr + - Assgne +example: + MsgId: 123 + CreDtTm: '2020-01-01T00:00:00Z' + Assgnr: + OrgId: + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC + Assgne: + OrgId: + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml new file mode 100644 index 00000000..f64aeafb --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml @@ -0,0 +1,22 @@ +title: IdentificationInformation4 +type: object +properties: + Pty: + $ref: ./PartyIdentification135.yaml + Acct: + $ref: ./CashAccount40.yaml + Agt: + $ref: ./BranchAndFinancialInstitutionIdentification6.yaml +example: + Pty: + Id: + OrgId: + AnyBIC: + BICFI: BICFI + CtryOfRes: FI + Acct: + Id: + IBAN: FI2112345600000785 + Agt: + FinInstnId: + BICFI: BICFI diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml new file mode 100644 index 00000000..6b5aa8ed --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml @@ -0,0 +1,3 @@ +title: IdentificationVerificationIndicator +type: boolean +example: true diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml new file mode 100644 index 00000000..714ae57c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml @@ -0,0 +1,14 @@ +title: Instruction4Code +description: > + Specifies further instructions concerning the processing of a payment + instruction, provided by the sending clearing agent to the next agent(s). + + PHOA PhoneNextAgent Please advise/contact next agent by phone. + + TELA TelecomNextAgent Please advise/contact next agent by the most efficient + means of telecommunication. +type: string +enum: + - PHOA + - TELA +example: PHOA diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml new file mode 100644 index 00000000..90f70343 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml @@ -0,0 +1,13 @@ +title: InstructionForCreditorAgent3 +description: > + Further information related to the processing of the payment instruction, + provided by the initiating party, and intended for the creditor agent. +type: object +properties: + Cd: + $ref: ./ExternalCreditorAgentInstruction1Code.yaml + InstrInf: + $ref: ./Max140Text.yaml +example: + Cd: PHOA + InstrInf: Please advise/contact next agent by phone. diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml new file mode 100644 index 00000000..e1c40c19 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml @@ -0,0 +1,13 @@ +title: InstructionForNextAgent1 +description: > + Further information related to the processing of the payment instruction, + provided by the initiating party, and intended for the creditor agent. +type: object +properties: + Cd: + $ref: ./Instruction4Code.yaml + InstrInf: + $ref: ./Max140Text.yaml +example: + Cd: PHOA + InstrInf: Please advise/contact next agent by phone diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml new file mode 100644 index 00000000..3affd21d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml @@ -0,0 +1,8 @@ +title: LEIIdentifier +description: > + Legal Entity Identifier is a code allocated to a party as described in + ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". + ^([0-9A-Z]{18,18}[0-9]{2,2})$ +type: string +pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ +example: 529900T8BM49AURSDO55 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml new file mode 100644 index 00000000..0c0c0f24 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml @@ -0,0 +1,14 @@ +title: LocalInstrument2Choice +type: object +properties: + Cd: + $ref: ./ExternalLocalInstrument1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CH03 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml new file mode 100644 index 00000000..fa01ffad --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml @@ -0,0 +1,7 @@ +title: Max105Text +description: | + Specifies a character string with a maximum length of 105 characters. +type: string +minLength: 1 +maxLength: 105 +example: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml new file mode 100644 index 00000000..63db3fae --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml @@ -0,0 +1,7 @@ +title: Max10Text +description: | + Specifies a character string with a maximum length of 10 characters. +type: string +minLength: 1 +maxLength: 10 +example: 1234567890 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml new file mode 100644 index 00000000..a62da878 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml @@ -0,0 +1,7 @@ +title: Max128Text +description: | + Specifies a character string with a maximum length of 128 characters. +type: string +minLength: 1 +maxLength: 128 +example: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml new file mode 100644 index 00000000..f63c2495 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml @@ -0,0 +1,7 @@ +title: Max140Text +description: | + Specifies a character string with a maximum length of 140 characters. +type: string +minLength: 1 +maxLength: 140 +example: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml new file mode 100644 index 00000000..95b56c3e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml @@ -0,0 +1,6 @@ +title: Max15NumericText +description: | + Specifies a numeric string with a maximum length of 15 digits. +type: string +pattern: ^[0-9]{1,15}$ +example: 123456789012345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml new file mode 100644 index 00000000..5618cdb6 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml @@ -0,0 +1,7 @@ +title: Max16Text +description: | + Specifies a character string with a maximum length of 16 characters. +type: string +minLength: 1 +maxLength: 16 +example: 1234567890123456 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml new file mode 100644 index 00000000..1c84f15e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml @@ -0,0 +1,7 @@ +title: Max2048Text +description: | + Specifies a character string with a maximum length of 2048 characters. +type: string +minLength: 1 +maxLength: 2048 +example: 2048 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml new file mode 100644 index 00000000..946cdc55 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml @@ -0,0 +1,7 @@ +title: Max256Text +description: | + Specifies a character string with a maximum length of 256 characters. +type: string +minLength: 1 +maxLength: 256 +example: 256 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml new file mode 100644 index 00000000..9bd2b556 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml @@ -0,0 +1,7 @@ +title: Max34Text +description: | + Specifies a character string with a maximum length of 34 characters. +type: string +minLength: 1 +maxLength: 34 +example: 1234567890123456789012345678901234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml new file mode 100644 index 00000000..65423628 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml @@ -0,0 +1,7 @@ +title: Max350Text +description: | + Specifies a character string with a maximum length of 350 characters. +type: string +minLength: 1 +maxLength: 350 +example: 350 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml new file mode 100644 index 00000000..350df954 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml @@ -0,0 +1,7 @@ +title: Max35Text +description: | + Specifies a character string with a maximum length of 35 characters. +type: string +minLength: 1 +maxLength: 35 +example: 12345678901234567890123456789012345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml new file mode 100644 index 00000000..064c2155 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml @@ -0,0 +1,7 @@ +title: Max4Text +description: | + Specifies a character string with a maximum length of 4 characters. +type: string +minLength: 1 +maxLength: 4 +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml new file mode 100644 index 00000000..a4bdb9db --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml @@ -0,0 +1,7 @@ +title: Max70Text +description: | + Specifies a character string with a maximum length of 70 characters. +type: string +minLength: 1 +maxLength: 70 +example: 1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml new file mode 100644 index 00000000..4fc6a951 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml @@ -0,0 +1,10 @@ +description: | + Specifies the terms used to formally address a person. +enum: + - DOCT + - MADM + - MISS + - MIST + - MIKS +type: string +example: DOCT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml new file mode 100644 index 00000000..e6b1420a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml @@ -0,0 +1,4 @@ +title: Number +type: string +pattern: ^[\d\-\.\,]{1,18}$ +example: 256 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml new file mode 100644 index 00000000..fa92e5ef --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml @@ -0,0 +1,19 @@ +title: OrganisationIdentification29 +description: | + Unique and unambiguous way to identify an organisation. +type: object +properties: + AnyBIC: + $ref: ./AnyBICDec2014Identifier.yaml + LEI: + $ref: ./LEIIdentifier.yaml + Othr: + $ref: ./GenericOrganisationIdentification1.yaml +example: + AnyBIC: BICFI + LEI: 529900T8BM49AURSDO55 + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml new file mode 100644 index 00000000..3b4afe7a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml @@ -0,0 +1,19 @@ +title: OrganisationIdentification39 +description: | + Unique and unambiguous way to identify an organisation. +type: object +properties: + AnyBIC: + $ref: ./AnyBICDec2014Identifier.yaml + LEI: + $ref: ./LEIIdentifier.yaml + Othr: + $ref: ./GenericOrganisationIdentification3.yaml +example: + AnyBIC: BICFI + LEI: 529900T8BM49AURSDO55 + Othr: + Id: 123 + SchmeNm: + Cd: BIC + Issr: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml new file mode 100644 index 00000000..5e34a91e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml @@ -0,0 +1,16 @@ +title: OrganisationIdentificationSchemeName1Choice +description: | + Choice of format for the organisation identification. +type: object +properties: + Cd: + $ref: ./ExternalOrganisationIdentification1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: BIC diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml new file mode 100644 index 00000000..f4985be2 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml @@ -0,0 +1,14 @@ +title: OtherContact1 +description: | + Communication device number or electronic address used for communication. +type: object +properties: + ChanlTp: + $ref: ./Max4Text.yaml + Id: + $ref: ./Max128Text.yaml +required: + - ChanlTp +example: + ChanlTp: PHON + Id: 1234567890 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml new file mode 100644 index 00000000..dabbb771 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml @@ -0,0 +1,35 @@ +title: PacsError_FIToFIPaymentStatusReportV15 +type: object +properties: + GrpHdr: + $ref: ./GroupHeader120.yaml + TxInfAndSts: + $ref: ./PaymentTransaction163.yaml + SplmtryData: + $ref: ./SupplementaryData1.yaml +required: + - GrpHdr +example: + GrpHdr: + MsgId: 12345 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: INDA + SttlmDt: '2020-01-01' + InstgAgt: + FinInstnId: + BICFI: BICFI + InstdAgt: + FinInstnId: + BICFI: BICFI + TxInfAndSts: + OrgnlInstrId: 12345 + OrgnlEndToEndId: 12345 + TxSts: RJCT + StsRsnInf: + Rsn: RSN + AddtlInf: ADDITIONAL + SplmtryData: + PlcAndNm: PLACE + Envlp: ENVELOPE diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml new file mode 100644 index 00000000..16460696 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml @@ -0,0 +1,79 @@ +title: PacsStatus_FIToFIPaymentStatusReportV15 +description: | + Unsure on description. +type: object +properties: + GrpHdr: + $ref: ./GroupHeader120.yaml +required: + - GrpHdr +example: + GrpHdr: + MsgId: 123 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + SttlmInf: + SttlmMtd: INDA + SttlmDt: '2020-01-01' + SttlmTmIndctn: RTGS + SttlmTmReq: '2020-01-01T00:00:00Z' + SttlmAcct: + Id: + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + ClrSys: + Prtry: 123 + InstgAgt: + FinInstnId: + BICFI: 123 + InstdAgt: + FinInstnId: + BICFI: 123 + InstgAgt: + FinInstnId: + BICFI: 123 + InstdAgt: + FinInstnId: + BICFI: 123 + IntrBkSttlmAmt: + Amt: 123 + Ccy: EUR + IntrBkSttlmDt: '2020-01-01' + TxSts: ACCP + StsRsnInf: + Orgtr: + Id: + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rsn: + Cd: 123 + Prtry: 123 + TxInfAndSts: + OrgnlInstrId: 123 + OrgnlEndToEndId: 123 + TxSts: ACCP + StsRsnInf: + Orgtr: + Id: + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + Rsn: + Cd: 123 + Prtry: 123 + ChrgsInf: + Amt: 123 + Ccy: EUR + IntrBkSttlmAmt: + Amt: 123 + Ccy: EUR + IntrBkSttlmDt: '2020-01-01' + SttlmTmIndctn: RTGS diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml new file mode 100644 index 00000000..af5a4d38 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml @@ -0,0 +1,21 @@ +title: Party38Choice +description: | + Nature or use of the account. +type: object +properties: + OrgId: + $ref: ./OrganisationIdentification29.yaml + PrvtId: + $ref: ./PersonIdentification13.yaml +oneOf: + - required: + - OrgId + - required: + - PrvtId +example: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml new file mode 100644 index 00000000..e737344c --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml @@ -0,0 +1,37 @@ +title: Party40Choice +description: | + Nature or use of the account. +type: object +properties: + Pty: + $ref: ./PartyIdentification135.yaml + Agt: + $ref: ./BranchAndFinancialInstitutionIdentification6.yaml +oneOf: + - required: + - Pty + - required: + - Agt +example: + Pty: + Nm: Name + PstlAdr: + Ctry: US + AdrLine: + - Line1 + - Line2 + Id: + OrgId: + AnyBIC: BIC + Agt: + FinInstnId: + BICFI: BUKBGB22 + BrnchId: + Id: 12345 + Nm: Oxford Street Branch + PstlAdr: + Ctry: GB + AdrLine: + - 1 Oxford Street + - London + - UK diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml new file mode 100644 index 00000000..724f465f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml @@ -0,0 +1,21 @@ +title: Party52Choice +description: | + Nature or use of the account. +type: object +properties: + OrgId: + $ref: ./OrganisationIdentification39.yaml + PrvtId: + $ref: ./PersonIdentification18.yaml +oneOf: + - required: + - OrgId + - required: + - PrvtId +example: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml new file mode 100644 index 00000000..e61c9dcf --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml @@ -0,0 +1,34 @@ +title: PartyIdentification135 +description: | + Specifies the identification of a person or an organisation. +type: object +properties: + Nm: + $ref: ./Max140Text.yaml + PstlAdr: + $ref: ./PostalAddress24.yaml + Id: + $ref: ./Party38Choice.yaml + CtryOfRes: + $ref: ./CountryCode.yaml + CtctDtls: + $ref: ./Contact4.yaml +example: + Nm: John Doe + PstlAdr: + Ctry: BE + AdrLine: + - Rue du Marché 45 + - Brussels + - BE + Id: + OrgId: + AnyBIC: CCCCUS33 + CtryOfRes: BE + CtctDtls: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml new file mode 100644 index 00000000..be6c09e5 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml @@ -0,0 +1,42 @@ +title: PartyIdentification272 +description: | + Specifies the identification of a person or an organisation. +type: object +properties: + Nm: + $ref: ./Max140Text.yaml + PstlAdr: + $ref: ./PostalAddress27.yaml + Id: + $ref: ./Party52Choice.yaml + CtryOfRes: + $ref: ./CountryCode.yaml + CtctDtls: + $ref: ./Contact13.yaml +example: + Nm: John Doe + PstlAdr: + AdrTp: ADDR + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + PstCd: PstCd + TwnNm: TwnNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + Id: + OrgId: + AnyBIC: BIC + PrvtId: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + CtryOfRes: BE + CtctDtls: + NmPrfx: Mr + Nm: John Doe + PhneNb: +123-123-321 + MobNb: +123-123-321 + FaxNb: +123-123-321 + EmailAdr: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml new file mode 100644 index 00000000..86517d16 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml @@ -0,0 +1,23 @@ +title: PaymentIdentification13 +description: | + Provides further means of referencing a payment transaction. +type: object +properties: + InstrId: + $ref: ./Max35Text.yaml + EndToEndId: + $ref: ./Max35Text.yaml + TxId: + $ref: ./Max35Text.yaml + UETR: + $ref: ./UUIDv4Identifier.yaml + ClrSysRef: + $ref: ./Max35Text.yaml +required: + - EndToEndId +example: + InstrId: INSTRUCTIONID + EndToEndId: ENDTOENDID + TxId: TRANSACTIONID + UETR: 123e4567-e89b-12d3-a456-426614174000 + ClrSysRef: CLRSYSREF diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml new file mode 100644 index 00000000..74583165 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml @@ -0,0 +1,47 @@ +title: PaymentTransaction163 +description: > + Provides further details on the original transactions, to which the status + report message refers. +type: object +properties: + StsId: + $ref: ./Max35Text.yaml + OrgnlInstrId: + $ref: ./Max35Text.yaml + OrgnlEndToEndId: + $ref: ./Max35Text.yaml + OrgnlTxId: + $ref: ./Max35Text.yaml + OrgnlUETR: + $ref: ./UUIDv4Identifier.yaml + TxSts: + $ref: ./ExternalPaymentTransactionStatus1Code.yaml + StsRsnInf: + $ref: ./StatusReasonInformation14.yaml + AccptncDtTm: + $ref: ./ISODateTime.yaml + AcctSvcrRef: + $ref: ./Max35Text.yaml + ClrSysRef: + $ref: ./Max35Text.yaml + ExctnConf: + $ref: ./Exact32HexBinaryText.yaml + SplmtryData: + $ref: ./SupplementaryData1.yaml +example: + StsId: 12345 + OrgnlInstrId: 12345 + OrgnlEndToEndId: 12345 + OrgnlTxId: 12345 + OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000 + TxSts: RJCT + StsRsnInf: + Rsn: RSN + AddtlInf: ADDITIONAL + AccptncDtTm: '2020-01-01T00:00:00Z' + AcctSvcrRef: ACCTSVCRREF + ClrSysRef: CLRSYSREF + ExctnConf: 1234567890ABCDEF + SplmtryData: + PlcAndNm: PLACE + Envlp: ENVELOPE diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml new file mode 100644 index 00000000..7e1d9912 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml @@ -0,0 +1,24 @@ +title: PaymentTypeInformation28 +description: | + Provides further details of the type of payment. +type: object +properties: + InstrPrty: + $ref: ./Priority2Code.yaml + ClrChanl: + $ref: ./ClearingChannel2Code.yaml + SvcLvl: + $ref: ./ServiceLevel8Choice.yaml + LclInstrm: + $ref: ./LocalInstrument2Choice.yaml + CtgyPurp: + $ref: ./CategoryPurpose1Choice.yaml +example: + InstrPrty: NORM + ClrChanl: RTGS + SvcLvl: + Cd: SEPA + LclInstrm: + Cd: CORE + CtgyPurp: + Cd: CASH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml new file mode 100644 index 00000000..f86d6135 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml @@ -0,0 +1,4 @@ +title: PercentageRate +type: string +pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$ +example: 1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml new file mode 100644 index 00000000..bc412e98 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml @@ -0,0 +1,18 @@ +title: PersonIdentification13 +description: | + Unique and unambiguous way to identify a person. +type: object +properties: + DtAndPlcOfBirth: + $ref: ./DateAndPlaceOfBirth1.yaml + Othr: + $ref: ./GenericPersonIdentification1.yaml +example: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + Othr: + Id: 123 + SchmeNm: + Cd: CUST + Prtry: 1 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml new file mode 100644 index 00000000..0f11f211 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml @@ -0,0 +1,18 @@ +title: PersonIdentification18 +description: | + Unique and unambiguous way to identify a person. +type: object +properties: + DtAndPlcOfBirth: + $ref: ./DateAndPlaceOfBirth1.yaml + Othr: + $ref: ./GenericPersonIdentification2.yaml +example: + DtAndPlcOfBirth: + Dt: '2018-01-01' + CityOfBirth: City + Othr: + Id: 123 + SchmeNm: + Cd: CUST + Prtry: 1 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml new file mode 100644 index 00000000..54f7eef2 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml @@ -0,0 +1,16 @@ +title: PersonIdentificationSchemeName1Choice +description: | + Sets of elements to identify a name of the identification scheme. +type: object +properties: + Cd: + $ref: ./ExternalPersonIdentification1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CCPT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml new file mode 100644 index 00000000..5e6e9b80 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml @@ -0,0 +1,5 @@ +title: PhoneNumber +type: string +description: | + Double check this regex. +pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$ diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml new file mode 100644 index 00000000..d43d89f8 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml @@ -0,0 +1,55 @@ +title: PostalAddress24 +type: object +description: > + Information that locates and identifies a specific address, as defined by + postal services. +properties: + AdrTp: + $ref: ./AddressType3Choice.yaml + Dept: + $ref: ./Max70Text.yaml + SubDept: + $ref: ./Max70Text.yaml + StrtNm: + $ref: ./Max70Text.yaml + BldgNb: + $ref: ./Max16Text.yaml + BldgNm: + $ref: ./Max35Text.yaml + Flr: + $ref: ./Max70Text.yaml + PstBx: + $ref: ./Max16Text.yaml + Room: + $ref: ./Max70Text.yaml + PstCd: + $ref: ./Max16Text.yaml + TwnNm: + $ref: ./Max35Text.yaml + TwnLctnNm: + $ref: ./Max35Text.yaml + DstrctNm: + $ref: ./Max35Text.yaml + CtrySubDvsn: + $ref: ./Max35Text.yaml + Ctry: + $ref: ./CountryCode.yaml + AdrLine: + $ref: ./Max70Text.yaml +example: + AdrTp: ADDR + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + BldgNm: BldgNm + Flr: Flr + PstBx: PstBx + Room: Room + PstCd: PstCd + TwnNm: TwnNm + TwnLctnNm: TwnLctnNm + DstrctNm: DstrctNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + AdrLine: AdrLine diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml new file mode 100644 index 00000000..0e4c1285 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml @@ -0,0 +1,61 @@ +title: PostalAddress27 +type: object +description: > + Information that locates and identifies a specific address, as defined by + postal services. +properties: + AdrTp: + $ref: ./AddressType3Choice.yaml + CareOf: + $ref: ./Max140Text.yaml + Dept: + $ref: ./Max70Text.yaml + SubDept: + $ref: ./Max70Text.yaml + StrtNm: + $ref: ./Max140Text.yaml + BldgNb: + $ref: ./Max16Text.yaml + BldgNm: + $ref: ./Max140Text.yaml + Flr: + $ref: ./Max70Text.yaml + UnitNb: + $ref: ./Max16Text.yaml + PstBx: + $ref: ./Max16Text.yaml + Room: + $ref: ./Max70Text.yaml + PstCd: + $ref: ./Max16Text.yaml + TwnNm: + $ref: ./Max140Text.yaml + TwnLctnNm: + $ref: ./Max140Text.yaml + DstrctNm: + $ref: ./Max140Text.yaml + CtrySubDvsn: + $ref: ./Max35Text.yaml + Ctry: + $ref: ./CountryCode.yaml + AdrLine: + $ref: ./Max70Text.yaml +example: + AdrTp: ADDR + CareOf: CareOf + Dept: Dept + SubDept: SubDept + StrtNm: StrtNm + BldgNb: BldgNb + BldgNm: BldgNm + Flr: Flr + UnitNb: UnitNb + PstBx: PstBx + Room: Room + PstCd: PstCd + TwnNm: TwnNm + TwnLctnNm: TwnLctnNm + DstrctNm: DstrctNm + CtrySubDvsn: CtrySubDvsn + Ctry: Ctry + AdrLine: AdrLine diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml new file mode 100644 index 00000000..e9cd86de --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml @@ -0,0 +1,11 @@ +title: PreferredContactMethod1Code +description: | + Preferred method used to reach the individual contact within an organisation. +type: string +enum: + - LETT + - MAIL + - PHON + - FAXX + - CELL +example: CELL diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml new file mode 100644 index 00000000..41e87586 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml @@ -0,0 +1,11 @@ +title: PreferredContactMethod2Code +description: | + Preferred method used to reach the individual contact within an organisation. +type: string +enum: + - LETT + - MAIL + - PHON + - FAXX + - CELL +example: MAIL diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml new file mode 100644 index 00000000..e09f960a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml @@ -0,0 +1,9 @@ +title: Priority2Code +description: > + Indicator of the urgency or order of importance that the instructing party + would like the instructed party to apply to the processing of the instruction. +type: string +enum: + - HIGH + - NORM +example: HIGH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml new file mode 100644 index 00000000..621b1e82 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml @@ -0,0 +1,15 @@ +title: ProxyAccountIdentification1 +description: | + Information related to a proxy identification of the account. +type: object +properties: + Tp: + $ref: ./ProxyAccountType1Choice.yaml + Id: + $ref: ./Max2048Text.yaml +required: + - Id +example: + Tp: + Cd: IBAN + Id: 123 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml new file mode 100644 index 00000000..e51740ce --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml @@ -0,0 +1,16 @@ +title: ProxyAccountType1Choice +type: object +description: | + NOTE: Unsure on description. +properties: + Cd: + $ref: ./ExternalProxyAccountType1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CH03 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml new file mode 100644 index 00000000..bf5c84e3 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml @@ -0,0 +1,21 @@ +title: Purpose2Choice +description: > + Specifies the underlying reason for the payment transaction. + + Usage: Purpose is used by the end-customers, that is initiating party, + (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose + is a content element, which is not used for processing by any of the agents involved in the payment + chain. +type: object +properties: + Cd: + $ref: ./ExternalPurpose1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: CH03 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml new file mode 100644 index 00000000..0b991196 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml @@ -0,0 +1,12 @@ +title: RegulatoryAuthority2 +description: | + Information about an entity requiring the regulatory reporting information. +type: object +properties: + Nm: + $ref: ./Max140Text.yaml + Ctry: + $ref: ./CountryCode.yaml +example: + Nm: Swiss National Bank + Ctry: CH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml new file mode 100644 index 00000000..a6a44d0f --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml @@ -0,0 +1,19 @@ +title: RegulatoryReporting3 +description: | + Information needed due to regulatory and/or statutory requirements. +type: object +properties: + DbtCdtRptgInd: + $ref: ./RegulatoryReportingType1Code.yaml + Authrty: + $ref: ./RegulatoryAuthority2.yaml + Dtls: + $ref: ./StructuredRegulatoryReporting3.yaml +example: + DbtCdtRptgInd: CRED + Authrty: + Nm: Swiss National Bank + Ctry: CH + Dtls: + Cd: A1 + Inf: Mandatory regulatory information diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml new file mode 100644 index 00000000..a12efbfb --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml @@ -0,0 +1,10 @@ +title: RegulatoryReportingType1Code +description: > + Identifies whether the regulatory reporting information applies to the debit + side, to the credit side or to both debit and credit sides of the transaction. +type: string +enum: + - CRED + - DEBT + - BOTH +example: BOTH diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml new file mode 100644 index 00000000..55a40abb --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml @@ -0,0 +1,16 @@ +title: ServiceLevel8Choice +description: | + Details about a service level. +type: object +properties: + Cd: + $ref: ./ExternalServiceLevel1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: SEPA diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml new file mode 100644 index 00000000..ca8d8a19 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml @@ -0,0 +1,40 @@ +title: SettlementInstruction15 +description: | + NOTE: Unsure on description. +type: object +properties: + SttlmMtd: + $ref: ./SettlementMethod1Code.yaml + PmtTpInf: + $ref: ./PaymentTypeInformation28.yaml +required: + - SttlmMtd +example: + SttlmMtd: INDA + PmtTpInf: + InstrPrty: NORM + SvcLvl: + Cd: SEPA + LclInstrm: + Cd: CH03 + CtgyPurp: + Cd: SUPP + Cdtr: + Nm: Name + PstlAdr: + AdrTp: ADDR + AdrLine: Address + Ctry: CH + Id: + OrgId: + AnyBIC: BIC + Othr: + Id: 123 + SchmeNm: + Cd: IBAN + Issr: BIC + CtryOfRes: CH + CtctDtls: + Nm: Name + PhneNb: 123 + EmailAdr: diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml new file mode 100644 index 00000000..9bdaadf2 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml @@ -0,0 +1,10 @@ +title: SettlementMethod1Code +description: | + Specifies the method used to settle the credit transfer instruction. +type: string +enum: + - INDA + - INGA + - COVE + - CLRG +example: CLRG diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml new file mode 100644 index 00000000..b915a0d3 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml @@ -0,0 +1,16 @@ +title: StatusReason6Choice +description: | + Unsure on description. +type: object +properties: + Cd: + $ref: ./ExternalStatusReason1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: AGNT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml new file mode 100644 index 00000000..c16cdca0 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml @@ -0,0 +1,27 @@ +title: StatusReasonInformation14 +description: | + Unsure on description. +type: object +properties: + Orgtr: + $ref: ./PartyIdentification272.yaml + Rsn: + $ref: ./StatusReason6Choice.yaml + AddtlInf: + $ref: ./Max105Text.yaml +example: + Orgtr: + Nm: Name + PstlAdr: + AdrTp: ADDR + Dept: Department + SubDept: SubDepartment + StrtNm: StreetName + BldgNb: BuildingNumber + PstCd: PostCode + TwnNm: TownName + CtrySubDvsn: CountrySubDivision + Ctry: Country + Rsn: + Cd: AGNT + AddtlInf: AdditionalInformation diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml new file mode 100644 index 00000000..4d0a2224 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml @@ -0,0 +1,26 @@ +title: StructuredRegulatoryReporting3 +description: | + Unsure on description. +type: object +properties: + Tp: + $ref: ./Max35Text.yaml + Dt: + $ref: ./ISODate.yaml + Ctry: + $ref: ./CountryCode.yaml + Cd: + $ref: ./Max10Text.yaml + Amt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + Inf: + $ref: ./Max35Text.yaml +example: + Tp: T1 + Dt: '2018-01-01' + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml new file mode 100644 index 00000000..185f845b --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml @@ -0,0 +1,17 @@ +title: SupplementaryData1 +description: > + Additional information that can not be captured in the structured fields + and/or any other specific block. +type: object +properties: + PlcAndNm: + $ref: ./Max350Text.yaml + Envlp: + $ref: ./SupplementaryDataEnvelope1.yaml +required: + - Envlp +example: + PlcAndNm: Additional information + Envlp: + Cd: CH03 + Prtry: Additional information diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml new file mode 100644 index 00000000..a3af5ba6 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml @@ -0,0 +1,5 @@ +title: SupplementaryDataEnvelope1 +description: | + Unsure on description. +type: object + diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml new file mode 100644 index 00000000..7853b108 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml @@ -0,0 +1,29 @@ +title: TaxAmount3 +description: | + Information on the amount of the tax record. +type: object +properties: + Rate: + $ref: ./PercentageRate.yaml + TaxblBaseAmt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + TtlAmt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + Dtls: + $ref: ./TaxRecordDetails3.yaml +example: + Rate: 0.0 + TaxblBaseAmt: + Ccy: EUR + Amt: 0 + TtlAmt: + Ccy: EUR + Amt: 0 + Dtls: + Tp: T1 + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml new file mode 100644 index 00000000..b9e8d88e --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml @@ -0,0 +1,12 @@ +title: TaxAuthorisation1 +description: | + Details of an authorised tax paying party. +type: object +properties: + Titl: + $ref: ./Max35Text.yaml + Nm: + $ref: ./Max140Text.yaml +example: + Titl: Mr + Nm: John Doe diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml new file mode 100644 index 00000000..b8f92726 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml @@ -0,0 +1,57 @@ +title: TaxData1 +description: > + Details about tax paid, or to be paid, to the government in accordance with + the law, including pre-defined parameters such as thresholds and type of account. +type: object +properties: + Cdtr: + $ref: ./TaxParty1.yaml + Dbtr: + $ref: ./TaxParty2.yaml + UltmtDbtr: + $ref: ./TaxParty2.yaml + AdmstnZone: + $ref: ./Max35Text.yaml + RefNb: + $ref: ./Max140Text.yaml + Mtd: + $ref: ./Max35Text.yaml + TtlTaxblBaseAmt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + TtlTaxAmt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml + Dt: + $ref: ./ISODate.yaml + SeqNb: + $ref: ./Number.yaml + Rcrd: + $ref: ./TaxRecord3.yaml +example: + Cdtr: + Titl: Mr + Nm: John Doe + Dbtr: + Titl: Mr + Nm: John Doe + UltmtDbtr: + Titl: Mr + Nm: John Doe + AdmstnZone: CH + RefNb: 12345 + Mtd: A + TtlTaxblBaseAmt: + Ccy: CHF + Amt: 1000 + TtlTaxAmt: + Ccy: CHF + Amt: 100 + Dt: '2018-01-01' + SeqNb: 1 + Rcrd: + Tp: T1 + Ctry: CH + Cd: CHF + Amt: + Ccy: CHF + Amt: 1000 + Inf: 12345 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml new file mode 100644 index 00000000..19b05f10 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml @@ -0,0 +1,15 @@ +title: TaxParty1 +description: | + Details about the entity involved in the tax paid or to be paid. +type: object +properties: + TaxId: + $ref: ./Max35Text.yaml + RegnId: + $ref: ./Max35Text.yaml + TaxTp: + $ref: ./Max35Text.yaml +example: + TaxId: 123456789 + RegnId: 123456789 + TaxTp: VAT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml new file mode 100644 index 00000000..9ddd82c4 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml @@ -0,0 +1,20 @@ +title: TaxParty2 +description: | + Details about the entity involved in the tax paid or to be paid. +type: object +properties: + TaxId: + $ref: ./Max35Text.yaml + RegnId: + $ref: ./Max35Text.yaml + TaxTp: + $ref: ./Max35Text.yaml + Authstn: + $ref: ./TaxAuthorisation1.yaml +example: + TaxId: 123456789 + RegnId: 123456789 + TaxTp: VAT + Authstn: + Titl: Mr + Nm: John Doe diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml new file mode 100644 index 00000000..c19b05d6 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml @@ -0,0 +1,17 @@ +title: TaxPeriod3 +description: | + Period of time details related to the tax payment. +type: object +properties: + Yr: + $ref: ./ISOYear.yaml + Tp: + $ref: ./TaxRecordPeriod1Code.yaml + FrToDt: + $ref: ./DatePeriod2.yaml +example: + Yr: 2020 + Tp: MM01 + FrToDt: + FrDt: '2020-01-01' + ToDt: '2020-01-31' diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml new file mode 100644 index 00000000..ff547544 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml @@ -0,0 +1,38 @@ +title: TaxRecord3 +description: | + Set of elements used to define the tax record. +type: object +properties: + Tp: + $ref: ./Max35Text.yaml + Ctgy: + $ref: ./Max35Text.yaml + CtgyDtls: + $ref: ./Max35Text.yaml + DbtrSts: + $ref: ./Max35Text.yaml + CertId: + $ref: ./Max35Text.yaml + FrmsCd: + $ref: ./Max35Text.yaml + Prd: + $ref: ./TaxPeriod3.yaml + TaxAmt: + $ref: ./TaxAmount3.yaml + AddtlInf: + $ref: ./Max140Text.yaml +example: + Tp: VAT + Ctgy: A + CtgyDtls: Standard + DbtrSts: Resident + CertId: 123456789 + FrmsCd: 123456789 + Prd: + FrstDay: '2019-01-01' + LastDay: '2019-12-31' + TaxAmt: + Rate: 0.2 + TaxblBaseAmt: 1000 + TtlAmt: 200 + AddtlInf: VAT applicable diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml new file mode 100644 index 00000000..19500b35 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml @@ -0,0 +1,21 @@ +title: TaxRecordDetails3 +description: | + Details on the tax period and amount +type: object +properties: + Prd: + $ref: ./TaxPeriod3.yaml + Amt: + $ref: ./ActiveOrHistoricCurrencyAndAmount.yaml +required: + - Amt +example: + Prd: + Yr: 2020 + Tp: MM01 + FrToDt: + FrDt: '2020-01-01' + ToDt: '2020-01-31' + Amt: + Amt: 100.00 + Ccy: EUR diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml new file mode 100644 index 00000000..ea1cf56d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml @@ -0,0 +1,43 @@ +title: TaxRecordPeriod1Code +description: | + Specifies the period related to the tax payment + + MM01 FirstMonth Tax is related to the second month of the period. + MM02 SecondMonth Tax is related to the first month of the period. + MM03 ThirdMonth Tax is related to the third month of the period. + MM04 FourthMonth Tax is related to the fourth month of the period. + MM05 FifthMonth Tax is related to the fifth month of the period. + MM06 SixthMonth Tax is related to the sixth month of the period. + MM07 SeventhMonth Tax is related to the seventh month of the period. + MM08 EighthMonth Tax is related to the eighth month of the period. + MM09 NinthMonth Tax is related to the ninth month of the period. + MM10 TenthMonth Tax is related to the tenth month of the period. + MM11 EleventhMonth Tax is related to the eleventh month of the period. + MM12 TwelfthMonth Tax is related to the twelfth month of the period. + QTR1 FirstQuarter Tax is related to the first quarter of the period. + QTR2 SecondQuarter Tax is related to the second quarter of the period. + QTR3 ThirdQuarter Tax is related to the third quarter of the period. + QTR4 FourthQuarter Tax is related to the forth quarter of the period. + HLF1 FirstHalf Tax is related to the first half of the period. + HLF2 SecondHalf Tax is related to the second half of the period. +type: string +enum: + - MM01 + - MM02 + - MM03 + - MM04 + - MM05 + - MM06 + - MM07 + - MM08 + - MM09 + - MM10 + - MM11 + - MM12 + - QTR1 + - QTR2 + - QTR3 + - QTR4 + - HLF1 + - HLF2 +example: HLF1 diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml new file mode 100644 index 00000000..a7234324 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml @@ -0,0 +1,25 @@ +title: TermsRequest_FIToFICustomerCreditProposal +type: object +properties: + GrpHdr: + $ref: ./GroupHeader129.yaml +required: + - GrpHdr +example: + GrpHdr: + MsgId: 123456789 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + CtrlSum: 100.00 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BBA + Prtry: Party Identification Scheme Name + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml new file mode 100644 index 00000000..0b7f7718 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml @@ -0,0 +1,28 @@ +title: TermsResponse_FIToFICustomerCreditConfirmation +type: object +properties: + GrpHdr: + $ref: ./GroupHeader129.yaml + CdtTrfTxInf: + $ref: ./CreditTransferTransaction67.yaml +required: + - GrpHdr + - CdtTrfTxInf +example: + GrpHdr: + MsgId: 123456789 + CreDtTm: '2020-01-01T00:00:00Z' + NbOfTxs: 1 + CtrlSum: 100.00 + InitgPty: + Nm: Initiating Party Name + Id: + OrgId: + Othr: + - Id: 123456789 + SchmeNm: + Cd: BBA + Prtry: Party Identification Scheme Name + FwdgAgt: + FinInstnId: + BICFI: BBBBBBBB diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml new file mode 100644 index 00000000..55a9f0df --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml @@ -0,0 +1,4 @@ +title: UUIDv4Identifier +type: string +pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ +example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml new file mode 100644 index 00000000..fe954d0d --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml @@ -0,0 +1,14 @@ +title: VerificationReason1Choice +type: object +properties: + Cd: + $ref: ./ExternalVerificationReason1Code.yaml + Prtry: + $ref: ./Max35Text.yaml +oneOf: + - required: + - Cd + - required: + - Prtry +example: + Cd: AGNT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml new file mode 100644 index 00000000..e63eb4be --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml @@ -0,0 +1,29 @@ +title: VerificationReport4 +type: object +properties: + OrgnlId: + $ref: ./Max35Text.yaml + Vrfctn: + $ref: ./IdentificationVerificationIndicator.yaml + Rsn: + $ref: ./VerificationReason1Choice.yaml + OrgnlPtyAndAcctId: + $ref: ./IdentificationInformation4.yaml + UpdtdPtyAndAcctId: + $ref: ./IdentificationInformation4.yaml +required: + - OrgnlId + - Vrfctn +example: + OrgnlId: 123456789 + Vrfctn: true + Rsn: + Cd: AGNT + OrgnlPtyAndAcctId: + Id: 123456789 + SchmeNm: + Cd: CCPT + UpdtdPtyAndAcctId: + Id: 123456789 + SchmeNm: + Cd: CCPT diff --git a/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml b/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml new file mode 100644 index 00000000..6365fc97 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml @@ -0,0 +1,4 @@ +title: hexBinary +type: string +pattern: ^(0x|0X)?[a-fA-F0-9]+$ +example: 0x1234 diff --git a/fspiop/v2_0_ISO20022/openapi3/openapi.yaml b/fspiop/v2_0_ISO20022/openapi3/openapi.yaml new file mode 100644 index 00000000..825f33ce --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/openapi.yaml @@ -0,0 +1,53 @@ +openapi: 3.0.2 +info: + version: v2.0-iso20022-draft + title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version + description: >- + IN PROGRESS + license: + name: CC BY-ND 4.0 + url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md + contact: + name: Sam Kummary + url: https://github.com/mojaloop/mojaloop-specification/issues +servers: + - url: 'protocol://hostname:/switch/' + variables: + protocol: + enum: + - http + - https + default: https +paths: + /parties/{Type}/{ID}: + $ref: paths/parties_{Type}_{ID}.yaml + /parties/{Type}/{ID}/error: + $ref: paths/parties_{Type}_{ID}_error.yaml + /parties/{Type}/{ID}/{SubId}: + $ref: paths/parties_{Type}_{ID}_{SubId}.yaml + /parties/{Type}/{ID}/{SubId}/error: + $ref: paths/parties_{Type}_{ID}_{SubId}_error.yaml + /quotes: + $ref: paths/quotes.yaml + /quotes/{ID}: + $ref: paths/quotes_{ID}.yaml + /quotes/{ID}/error: + $ref: paths/quotes_{ID}_error.yaml + /transfers: + $ref: paths/transfers.yaml + /transfers/{ID}: + $ref: paths/transfers_{ID}.yaml + /transfers/{ID}/error: + $ref: paths/transfers_{ID}_error.yaml + /fxQuotes: + $ref: paths/fxQuotes.yaml + /fxQuotes/{ID}: + $ref: paths/fxQuotes_{ID}.yaml + /fxQuotes/{ID}/error: + $ref: paths/fxQuotes_{ID}_error.yaml + /fxTransfers: + $ref: paths/fxTransfers.yaml + /fxTransfers/{ID}: + $ref: paths/fxTransfers_{ID}.yaml + /fxTransfers/{ID}/error: + $ref: paths/fxTransfers_{ID}_error.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml new file mode 100644 index 00000000..ad66c4f3 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml @@ -0,0 +1,46 @@ +post: + description: >- + The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a + quotation for a currency conversion. + summary: Calculate FX quote + tags: + - fxQuotes + operationId: FxQuotesPost + parameters: + - $ref: ../components/parameters/Accept.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the FX quote to be created. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/FxRequest_FICreditTransferProposal.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml new file mode 100644 index 00000000..b7442ace --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml @@ -0,0 +1,81 @@ +parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml +get: + description: >- + The HTTP request `GET /fxQuotes/{ID}` is used to request information + regarding a request for quotation for a currency conversion which the + sender has previously issued. The `{ID}` in the URI should contain the + `conversionRequestId` that was used for the creation of the quote. + summary: Retrieve FX quote information + tags: + - fxQuotes + operationId: FxQuotesByIDGet + parameters: + - $ref: ../components/parameters/Accept.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +put: + description: >- + The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the + outcome of a request for quotation for a currency conversion. The `{ID}` in + the URI should contain the `conversionRequestId` that was used for the + creation of the FX quote, or the `{ID}` that was used in the `GET + /fxQuotes/{ID}` request. + summary: Return FX quote information + tags: + - fxQuotes + operationId: FxQuotesByIdPut + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: FX Quote information returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/FxResponse_FICreditTransferConfirmation.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml new file mode 100644 index 00000000..e63fb414 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml @@ -0,0 +1,49 @@ +put: + description: >- + If the FXP is unable to find or create a FX quote, or some other processing + error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The + `{ID}` in the URI should contain the `conversionRequestId` that was used for + the creation of the FX quote, or the `{ID}` that was used in the `GET + /fxQuotes/{ID}` request. + summary: Return FX quote information error + tags: + - fxQuotes + operationId: FxQuotesByIDAndErrorPut + parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml new file mode 100644 index 00000000..d63b7fb0 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml @@ -0,0 +1,47 @@ +post: + description: >- + The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the + execution of an agreed currency conversion. + summary: Perform FX transfer + tags: + - fxTransfers + operationId: FxTransfersPost + parameters: + - $ref: ../components/parameters/Accept.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the FX transfer to be created. + required: true + content: + application/json: + schema: + $ref: >- + ../components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml new file mode 100644 index 00000000..150957c1 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml @@ -0,0 +1,120 @@ +parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml +get: + description: >- + The HTTP request `GET /fxTransfers/{ID}` s used to request information + regarding a request for confirmation of a currency conversion which the + sender has previously issued. The `{ID}` in the URI should contain the + `commitRequestId` that was used for the creation of the FX transfer. + summary: Retrieve FX transfer information + tags: + - fxTransfers + operationId: FxTransfersByIDGet + parameters: + - $ref: ../components/parameters/Accept.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +patch: + description: >- + The HTTP request PATCH /fxTransfers/ is used to inform the requester + about the final determination by the switch of the transfer a request for + execution of a currency conversion. The in the URI should contain the + commitRequestId that was used for the creation of the FX transfer. Please + note that this request does not generate a callback. + summary: Return FX transfer information + tags: + - fxTransfers + operationId: FxTransfersByIDPatch + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Transfer notification upon completion. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +put: + description: >- + The callback `PUT /fxTransfers/{ID}` is used to inform the requester about + the outcome of a request for execution of a currency conversion. The `{ID}` + in the URI should contain the `commitRequestId` that was used for the + creation of the FX transfer, or the `{ID}` that was used in the `GET + /fxTransfers/{ID}` request. + summary: Return FX transfer information + tags: + - fxTransfers + operationId: FxTransfersByIDPut + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Transfer information returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml new file mode 100644 index 00000000..80a9bda5 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml @@ -0,0 +1,49 @@ +put: + description: >- + If the switch or FXP is unable to find or create a FX transfer, or another + processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is + used. The `{ID}` in the URI should contain the `commitRequestId` that was + used for the creation of the FX transfer, or the `{ID}` that was used in the + `GET /fxTransfers/{ID}`. + summary: Return FX transfer information error + tags: + - fxTransfers + operationId: FxTransfersByIDAndErrorPut + parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml new file mode 100644 index 00000000..84684034 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml @@ -0,0 +1,82 @@ +parameters: + - $ref: ../components/parameters/Type.yaml + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml +get: + description: >- + The HTTP request `GET /parties/{Type}/{ID}` (or `GET + /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the + requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for + example, `GET /parties/MSISDN/123456789`, or `GET + /parties/BUSINESS/shoecompany/employee1`). + summary: Look up party information + tags: + - parties + operationId: PartiesByTypeAndID + parameters: + - $ref: ../components/parameters/Accept.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +put: + description: >- + The callback `PUT /parties/{Type}/{ID}` (or `PUT + /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful + result of the Party information lookup. + summary: Return party information + tags: + - parties + operationId: PartiesByTypeAndID2 + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Party information returned. + required: true + content: + application/json: + schema: + $ref: >- + ../components/schemas/GetParties_IdentificationVerificationReportV03.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml new file mode 100644 index 00000000..27dd307a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml @@ -0,0 +1,50 @@ +put: + description: >- + If the server is unable to find Party information of the provided identity, + or another processing error occurred, the error callback `PUT + /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is + used. + summary: Return party information error + tags: + - parties + operationId: PartiesErrorByTypeAndID + parameters: + - $ref: ../components/parameters/Type.yaml + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: >- + ../components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml new file mode 100644 index 00000000..dabc8a97 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml @@ -0,0 +1,83 @@ +parameters: + - $ref: ../components/parameters/Type.yaml + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/SubId.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml +get: + description: >- + The HTTP request `GET /parties/{Type}/{ID}` (or `GET + /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the + requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for + example, `GET /parties/MSISDN/123456789`, or `GET + /parties/BUSINESS/shoecompany/employee1`). + summary: Look up party information + tags: + - parties + operationId: PartiesSubIdByTypeAndID + parameters: + - $ref: ../components/parameters/Accept.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +put: + description: >- + The callback `PUT /parties/{Type}/{ID}` (or `PUT + /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful + result of the Party information lookup. + summary: Return party information + tags: + - parties + operationId: PartiesSubIdByTypeAndIDPut + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Party information returned. + required: true + content: + application/json: + schema: + $ref: >- + ../components/schemas/GetParties_IdentificationVerificationReportV03.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml new file mode 100644 index 00000000..fac73347 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml @@ -0,0 +1,51 @@ +put: + description: >- + If the server is unable to find Party information of the provided identity, + or another processing error occurred, the error callback `PUT + /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is + used. + summary: Return party information error + tags: + - parties + operationId: PartiesSubIdErrorByTypeAndID + parameters: + - $ref: ../components/parameters/Type.yaml + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/SubId.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: >- + ../components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml new file mode 100644 index 00000000..2ffcc79a --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml @@ -0,0 +1,46 @@ +post: + description: >- + The HTTP request `POST /quotes` is used to request the creation of a quote + for the provided financial transaction in the server. + summary: Calculate quote + tags: + - quotes + operationId: Quotes + parameters: + - $ref: ../components/parameters/Accept.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the quote to be created. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml new file mode 100644 index 00000000..eb1f4259 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml @@ -0,0 +1,80 @@ +parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml +get: + description: >- + The HTTP request `GET /quotes/{ID}` is used to get information regarding a + quote created or requested earlier. The `{ID}` in the URI should contain the + `quoteId` that was used for the creation of the quote. + summary: Retrieve quote information + tags: + - quotes + operationId: QuotesByID + parameters: + - $ref: ../components/parameters/Accept.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +put: + description: >- + The callback `PUT /quotes/{ID}` is used to inform the client of a requested + or created quote. The `{ID}` in the URI should contain the `quoteId` that + was used for the creation of the quote, or the `{ID}` that was used in the + `GET /quotes/{ID}` request. + summary: Return quote information + tags: + - quotes + operationId: QuotesByID1 + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Quote information returned. + required: true + content: + application/json: + schema: + $ref: >- + ../components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml new file mode 100644 index 00000000..d98e6cab --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml @@ -0,0 +1,49 @@ +put: + description: >- + If the server is unable to find or create a quote, or some other processing + error occurs, the error callback `PUT /quotes/{ID}/error` is used. The + `{ID}` in the URI should contain the `quoteId` that was used for the + creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` + request. + summary: Return quote information error + tags: + - quotes + operationId: QuotesByIDAndError + parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml new file mode 100644 index 00000000..81f1ecce --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml @@ -0,0 +1,46 @@ +post: + description: >- + The HTTP request `POST /transfers` is used to request the creation of a + transfer for the next ledger, and a financial transaction for the Payee FSP. + summary: Perform transfer + tags: + - transfers + operationId: transfers + parameters: + - $ref: ../components/parameters/Accept.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the transfer to be created. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml new file mode 100644 index 00000000..16fa1640 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml @@ -0,0 +1,119 @@ +parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml +get: + description: >- + The HTTP request `GET /transfers/{ID}` is used to get information regarding + a transfer created or requested earlier. The `{ID}` in the URI should + contain the `transferId` that was used for the creation of the transfer. + summary: Retrieve transfer information + tags: + - transfers + operationId: TransfersByIDGet + parameters: + - $ref: ../components/parameters/Accept.yaml + responses: + '202': + $ref: ../components/responses/202.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +patch: + description: >- + The HTTP request PATCH /transfers/ is used by a Switch to update the + state of a previously reserved transfer, if the Payee FSP has requested a + commit notification when the Switch has completed processing of the + transfer. The in the URI should contain the transferId that was used + for the creation of the transfer. Please note that this request does not + generate a callback. + summary: Return transfer information + tags: + - transfers + operationId: TransfersByIDPatch + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Transfer notification upon completion. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml +put: + description: >- + The callback `PUT /transfers/{ID}` is used to inform the client of a + requested or created transfer. The `{ID}` in the URI should contain the + `transferId` that was used for the creation of the transfer, or the `{ID}` + that was used in the `GET /transfers/{ID}` request. + summary: Return transfer information + tags: + - transfers + operationId: TransfersByIDPut + parameters: + - $ref: ../components/parameters/Content-Length.yaml + requestBody: + description: Transfer information returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml b/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml new file mode 100644 index 00000000..eac9dda3 --- /dev/null +++ b/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml @@ -0,0 +1,49 @@ +put: + description: >- + If the server is unable to find or create a transfer, or another processing + error occurs, the error callback `PUT /transfers/{ID}/error` is used. The + `{ID}` in the URI should contain the `transferId` that was used for the + creation of the transfer, or the `{ID}` that was used in the `GET + /transfers/{ID}`. + summary: Return transfer information error + tags: + - transfers + operationId: TransfersByIDAndError + parameters: + - $ref: ../components/parameters/ID.yaml + - $ref: ../components/parameters/Content-Length.yaml + - $ref: ../components/parameters/Content-Type.yaml + - $ref: ../components/parameters/Date.yaml + - $ref: ../components/parameters/X-Forwarded-For.yaml + - $ref: ../components/parameters/FSPIOP-Source.yaml + - $ref: ../components/parameters/FSPIOP-Destination.yaml + - $ref: ../components/parameters/FSPIOP-Encryption.yaml + - $ref: ../components/parameters/FSPIOP-Signature.yaml + - $ref: ../components/parameters/FSPIOP-URI.yaml + - $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml + requestBody: + description: Details of the error returned. + required: true + content: + application/json: + schema: + $ref: ../components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml + responses: + '200': + $ref: ../components/responses/200.yaml + '400': + $ref: ../components/responses/400.yaml + '401': + $ref: ../components/responses/401.yaml + '403': + $ref: ../components/responses/403.yaml + '404': + $ref: ../components/responses/404.yaml + '405': + $ref: ../components/responses/405.yaml + '406': + $ref: ../components/responses/406.yaml + '501': + $ref: ../components/responses/501.yaml + '503': + $ref: ../components/responses/503.yaml diff --git a/package-lock.json b/package-lock.json index 488a33ba..2562e802 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,44 +16,44 @@ "js-yaml": "^4.1.0", "json-refs": "^3.0.15", "openapi-types": "^12.1.3", - "openapi-typescript": "^6.7.6", - "ts-auto-mock": "^3.7.3" + "openapi-typescript": "^7.4.0", + "ts-auto-mock": "^3.7.4" }, "devDependencies": { - "@commitlint/cli": "^19.3.0", - "@commitlint/config-conventional": "^19.2.2", + "@commitlint/cli": "^19.4.1", + "@commitlint/config-conventional": "^19.4.1", "@redocly/cli": "^1.5.0", - "@redocly/openapi-cli": "^1.0.0-beta.94", + "@redocly/openapi-cli": "^1.0.0-beta.95", "@types/jest": "^29.5.12", "@types/js-yaml": "^4.0.9", - "@typescript-eslint/eslint-plugin": "^7.11.0", - "@typescript-eslint/parser": "^7.11.0", - "audit-ci": "^7.0.0", + "@typescript-eslint/eslint-plugin": "^8.4.0", + "@typescript-eslint/parser": "^8.4.0", + "audit-ci": "^7.1.0", "browser-sync": "^3.0.2", - "diff": "^5.2.0", + "diff": "^7.0.0", "eslint": "^8.55.0", "eslint-config-prettier": "^9.1.0", "eslint-config-standard": "^17.1.0", - "eslint-import-resolver-typescript": "^3.6.1", + "eslint-import-resolver-typescript": "^3.6.3", "eslint-plugin-cucumber": "^2.0.0", - "eslint-plugin-import": "^2.29.1", + "eslint-plugin-import": "^2.30.0", "eslint-plugin-node": "^11.1.0", - "eslint-plugin-prettier": "^5.1.3", + "eslint-plugin-prettier": "^5.2.1", "eslint-plugin-promise": "^6.2.0", "eslint-plugin-standard": "^5.0.0", - "husky": "9.0.11", + "husky": "9.1.5", "jest": "^29.7.0", "jest-junit": "^16.0.0", - "lint-staged": "^15.2.5", - "npm-check-updates": "^16.14.20", - "prettier": "^3.3.0", + "lint-staged": "^15.2.10", + "npm-check-updates": "^17.1.1", + "prettier": "^3.3.3", "standard-version": "^9.5.0", "swagger-cli": "^4.0.4", - "ts-jest": "^29.1.4", + "ts-jest": "^29.2.5", "ts-node": "^10.9.2", - "ts-patch": "^3.1.2", - "tslib": "^2.6.2", - "typescript": "^5.4.5" + "ts-patch": "^3.2.1", + "tslib": "^2.7.0", + "typescript": "^5.6.2" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -360,7 +360,6 @@ "version": "7.22.13", "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.22.13.tgz", "integrity": "sha512-XktuhWlJ5g+3TJXc5upd9Ks1HutSArik6jf2eAjYFyIOf4ej3RN+184cZbzDvbPnuTJIUhPKKJE3cIsYTiAT3w==", - "dev": true, "dependencies": { "@babel/highlight": "^7.22.13", "chalk": "^2.4.2" @@ -373,7 +372,6 @@ "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, "dependencies": { "color-convert": "^1.9.0" }, @@ -385,7 +383,6 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, "dependencies": { "ansi-styles": "^3.2.1", "escape-string-regexp": "^1.0.5", @@ -399,7 +396,6 @@ "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, "dependencies": { "color-name": "1.1.3" } @@ -407,14 +403,12 @@ "node_modules/@babel/code-frame/node_modules/color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", - "dev": true + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==" }, "node_modules/@babel/code-frame/node_modules/escape-string-regexp": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", - "dev": true, "engines": { "node": ">=0.8.0" } @@ -423,7 +417,6 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", - "dev": true, "engines": { "node": ">=4" } @@ -432,7 +425,6 @@ "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, "dependencies": { "has-flag": "^3.0.0" }, @@ -655,7 +647,6 @@ "version": "7.22.20", "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.22.20.tgz", "integrity": "sha512-Y4OZ+ytlatR8AI+8KZfKuL5urKp7qey08ha31L8b3BwewJAoJamTzyvxPR/5D+KkdJCGPq/+8TukHBlY10FX9A==", - "dev": true, "engines": { "node": ">=6.9.0" } @@ -687,7 +678,6 @@ "version": "7.22.20", "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.22.20.tgz", "integrity": "sha512-dkdMCN3py0+ksCgYmGG8jKeGA/8Tk+gJwSYYlFGxG5lmhfKNoAy004YpLxpS1W2J8m/EK2Ew+yOs9pVRwO89mg==", - "dev": true, "dependencies": { "@babel/helper-validator-identifier": "^7.22.20", "chalk": "^2.4.2", @@ -701,7 +691,6 @@ "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, "dependencies": { "color-convert": "^1.9.0" }, @@ -713,7 +702,6 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, "dependencies": { "ansi-styles": "^3.2.1", "escape-string-regexp": "^1.0.5", @@ -727,7 +715,6 @@ "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, "dependencies": { "color-name": "1.1.3" } @@ -735,14 +722,12 @@ "node_modules/@babel/highlight/node_modules/color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", - "dev": true + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==" }, "node_modules/@babel/highlight/node_modules/escape-string-regexp": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", - "dev": true, "engines": { "node": ">=0.8.0" } @@ -751,7 +736,6 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", - "dev": true, "engines": { "node": ">=4" } @@ -760,7 +744,6 @@ "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, "dependencies": { "has-flag": "^3.0.0" }, @@ -1033,26 +1016,16 @@ "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", "dev": true }, - "node_modules/@colors/colors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", - "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", - "dev": true, - "optional": true, - "engines": { - "node": ">=0.1.90" - } - }, "node_modules/@commitlint/cli": { - "version": "19.3.0", - "resolved": "https://registry.npmjs.org/@commitlint/cli/-/cli-19.3.0.tgz", - "integrity": "sha512-LgYWOwuDR7BSTQ9OLZ12m7F/qhNY+NpAyPBgo4YNMkACE7lGuUnuQq1yi9hz1KA4+3VqpOYl8H1rY/LYK43v7g==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/cli/-/cli-19.4.1.tgz", + "integrity": "sha512-EerFVII3ZcnhXsDT9VePyIdCJoh3jEzygN1L37MjQXgPfGS6fJTWL/KHClVMod1d8w94lFC3l4Vh/y5ysVAz2A==", "dev": true, "dependencies": { "@commitlint/format": "^19.3.0", - "@commitlint/lint": "^19.2.2", - "@commitlint/load": "^19.2.0", - "@commitlint/read": "^19.2.1", + "@commitlint/lint": "^19.4.1", + "@commitlint/load": "^19.4.0", + "@commitlint/read": "^19.4.0", "@commitlint/types": "^19.0.3", "execa": "^8.0.1", "yargs": "^17.0.0" @@ -1199,9 +1172,9 @@ } }, "node_modules/@commitlint/config-conventional": { - "version": "19.2.2", - "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.2.2.tgz", - "integrity": "sha512-mLXjsxUVLYEGgzbxbxicGPggDuyWNkf25Ht23owXIH+zV2pv1eJuzLK3t1gDY5Gp6pxdE60jZnWUY5cvgL3ufw==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.4.1.tgz", + "integrity": "sha512-D5S5T7ilI5roybWGc8X35OBlRXLAwuTseH1ro0XgqkOWrhZU8yOwBOslrNmSDlTXhXLq8cnfhQyC42qaUCzlXA==", "dev": true, "dependencies": { "@commitlint/types": "^19.0.3", @@ -1301,14 +1274,14 @@ } }, "node_modules/@commitlint/lint": { - "version": "19.2.2", - "resolved": "https://registry.npmjs.org/@commitlint/lint/-/lint-19.2.2.tgz", - "integrity": "sha512-xrzMmz4JqwGyKQKTpFzlN0dx0TAiT7Ran1fqEBgEmEj+PU98crOFtysJgY+QdeSagx6EDRigQIXJVnfrI0ratA==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/lint/-/lint-19.4.1.tgz", + "integrity": "sha512-Ws4YVAZ0jACTv6VThumITC1I5AG0UyXMGua3qcf55JmXIXm/ejfaVKykrqx7RyZOACKVAs8uDRIsEsi87JZ3+Q==", "dev": true, "dependencies": { "@commitlint/is-ignored": "^19.2.2", "@commitlint/parse": "^19.0.3", - "@commitlint/rules": "^19.0.3", + "@commitlint/rules": "^19.4.1", "@commitlint/types": "^19.0.3" }, "engines": { @@ -1316,9 +1289,9 @@ } }, "node_modules/@commitlint/load": { - "version": "19.2.0", - "resolved": "https://registry.npmjs.org/@commitlint/load/-/load-19.2.0.tgz", - "integrity": "sha512-XvxxLJTKqZojCxaBQ7u92qQLFMMZc4+p9qrIq/9kJDy8DOrEa7P1yx7Tjdc2u2JxIalqT4KOGraVgCE7eCYJyQ==", + "version": "19.4.0", + "resolved": "https://registry.npmjs.org/@commitlint/load/-/load-19.4.0.tgz", + "integrity": "sha512-I4lCWaEZYQJ1y+Y+gdvbGAx9pYPavqZAZ3/7/8BpWh+QjscAn8AjsUpLV2PycBsEx7gupq5gM4BViV9xwTIJuw==", "dev": true, "dependencies": { "@commitlint/config-validator": "^19.0.3", @@ -1447,9 +1420,9 @@ } }, "node_modules/@commitlint/read": { - "version": "19.2.1", - "resolved": "https://registry.npmjs.org/@commitlint/read/-/read-19.2.1.tgz", - "integrity": "sha512-qETc4+PL0EUv7Q36lJbPG+NJiBOGg7SSC7B5BsPWOmei+Dyif80ErfWQ0qXoW9oCh7GTpTNRoaVhiI8RbhuaNw==", + "version": "19.4.0", + "resolved": "https://registry.npmjs.org/@commitlint/read/-/read-19.4.0.tgz", + "integrity": "sha512-r95jLOEZzKDakXtnQub+zR3xjdnrl2XzerPwm7ch1/cc5JGq04tyaNpa6ty0CRCWdVrk4CZHhqHozb8yZwy2+g==", "dev": true, "dependencies": { "@commitlint/top-level": "^19.0.0", @@ -1664,9 +1637,9 @@ } }, "node_modules/@commitlint/rules": { - "version": "19.0.3", - "resolved": "https://registry.npmjs.org/@commitlint/rules/-/rules-19.0.3.tgz", - "integrity": "sha512-TspKb9VB6svklxNCKKwxhELn7qhtY1rFF8ls58DcFd0F97XoG07xugPjjbVnLqmMkRjZDbDIwBKt9bddOfLaPw==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/rules/-/rules-19.4.1.tgz", + "integrity": "sha512-AgctfzAONoVxmxOXRyxXIq7xEPrd7lK/60h2egp9bgGUMZK9v0+YqLOA+TH+KqCa63ZoCr8owP2YxoSSu7IgnQ==", "dev": true, "dependencies": { "@commitlint/ensure": "^19.0.3", @@ -1906,9 +1879,9 @@ } }, "node_modules/@commitlint/top-level/node_modules/yocto-queue": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.0.0.tgz", - "integrity": "sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz", + "integrity": "sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==", "dev": true, "engines": { "node": ">=12.20" @@ -2069,14 +2042,6 @@ "integrity": "sha512-5Aap/GaRupgNx/feGBwLLTVv8OQFfv3pq2lPRzPg9R+IOBnDgghTGW7l7EuVXOvg5cc/xSAlRW8rBrjIC3Nvqw==", "dev": true }, - "node_modules/@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", - "engines": { - "node": ">=14" - } - }, "node_modules/@humanwhocodes/config-array": { "version": "0.11.14", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", @@ -2119,79 +2084,6 @@ "node": ">=6.9.0" } }, - "node_modules/@isaacs/cliui": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", - "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, - "dependencies": { - "string-width": "^5.1.2", - "string-width-cjs": "npm:string-width@^4.2.0", - "strip-ansi": "^7.0.1", - "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", - "wrap-ansi": "^8.1.0", - "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@isaacs/cliui/node_modules/ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, "node_modules/@istanbuljs/load-nyc-config": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", @@ -2647,6 +2539,7 @@ "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -2659,6 +2552,7 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, "engines": { "node": ">= 8" } @@ -2667,6 +2561,7 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" @@ -2675,152 +2570,13 @@ "node": ">= 8" } }, - "node_modules/@npmcli/fs": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-3.1.0.tgz", - "integrity": "sha512-7kZUAaLscfgbwBQRbvdMYaZOWyMEcPTH/tJjnyAWJ/dvvs9Ef+CERx/qJb9GExJpl1qipaDGn7KqHnFGGixd0w==", - "dev": true, - "dependencies": { - "semver": "^7.3.5" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/git": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/@npmcli/git/-/git-4.1.0.tgz", - "integrity": "sha512-9hwoB3gStVfa0N31ymBmrX+GuDGdVA/QWShZVqE0HK2Af+7QGGrCTbZia/SW0ImUTjTne7SP91qxDmtXvDHRPQ==", - "dev": true, - "dependencies": { - "@npmcli/promise-spawn": "^6.0.0", - "lru-cache": "^7.4.4", - "npm-pick-manifest": "^8.0.0", - "proc-log": "^3.0.0", - "promise-inflight": "^1.0.1", - "promise-retry": "^2.0.1", - "semver": "^7.3.5", - "which": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/git/node_modules/lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true, - "engines": { - "node": ">=12" - } - }, - "node_modules/@npmcli/git/node_modules/which": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", - "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", - "dev": true, - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/which.js" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/installed-package-contents": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@npmcli/installed-package-contents/-/installed-package-contents-2.0.2.tgz", - "integrity": "sha512-xACzLPhnfD51GKvTOOuNX2/V4G4mz9/1I2MfDoye9kBM3RYe5g2YbscsaGoTlaWqkxeiapBWyseULVKpSVHtKQ==", - "dev": true, - "dependencies": { - "npm-bundled": "^3.0.0", - "npm-normalize-package-bin": "^3.0.0" - }, - "bin": { - "installed-package-contents": "lib/index.js" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/node-gyp": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@npmcli/node-gyp/-/node-gyp-3.0.0.tgz", - "integrity": "sha512-gp8pRXC2oOxu0DUE1/M3bYtb1b3/DbJ5aM113+XJBgfXdussRAsX0YOrOhdd8WvnAR6auDBvJomGAkLKA5ydxA==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/promise-spawn": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/@npmcli/promise-spawn/-/promise-spawn-6.0.2.tgz", - "integrity": "sha512-gGq0NJkIGSwdbUt4yhdF8ZrmkGKVz9vAdVzpOfnom+V8PLSmSOVhZwbNvZZS1EYcJN5hzzKBxmmVVAInM6HQLg==", - "dev": true, - "dependencies": { - "which": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/promise-spawn/node_modules/which": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", - "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", - "dev": true, - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/which.js" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/run-script": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/@npmcli/run-script/-/run-script-6.0.2.tgz", - "integrity": "sha512-NCcr1uQo1k5U+SYlnIrbAh3cxy+OQT1VtqiAbxdymSlptbzBb62AjH2xXgjNCoP073hoa1CfCAcwoZ8k96C4nA==", - "dev": true, - "dependencies": { - "@npmcli/node-gyp": "^3.0.0", - "@npmcli/promise-spawn": "^6.0.0", - "node-gyp": "^9.0.0", - "read-package-json-fast": "^3.0.0", - "which": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@npmcli/run-script/node_modules/which": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", - "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", - "dev": true, - "dependencies": { - "isexe": "^2.0.0" - }, - "bin": { - "node-which": "bin/which.js" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@pkgjs/parseargs": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", - "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", + "node_modules/@nolyfill/is-core-module": { + "version": "1.0.39", + "resolved": "https://registry.npmjs.org/@nolyfill/is-core-module/-/is-core-module-1.0.39.tgz", + "integrity": "sha512-nn5ozdjYQpUCZlWGuxcJY/KpxkWQs4DcbMCmKojjyrYDEAGy4Ce19NN4v5MduafTwJlbKc99UA8YhSVqq9yPZA==", "dev": true, - "optional": true, "engines": { - "node": ">=14" + "node": ">=12.4.0" } }, "node_modules/@pkgr/core": { @@ -2835,31 +2591,6 @@ "url": "https://opencollective.com/unts" } }, - "node_modules/@pnpm/network.ca-file": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.1.tgz", - "integrity": "sha512-gkINruT2KUhZLTaiHxwCOh1O4NVnFT0wLjWFBHmTz9vpKag/C/noIMJXBxFe4F0mYpUVX2puLwAieLYFg2NvoA==", - "dev": true, - "dependencies": { - "graceful-fs": "4.2.10" - }, - "engines": { - "node": ">=12.22.0" - } - }, - "node_modules/@pnpm/npm-conf": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-1.0.4.tgz", - "integrity": "sha512-o5YFq/+ksEJMbSzzkaQDHlp00aonLDU5xNPVTRL12hTWBbVSSeWXxPukq75h+mvXnoOWT95vV2u1HSTw2C4XOw==", - "dev": true, - "dependencies": { - "@pnpm/network.ca-file": "^1.0.1", - "config-chain": "^1.1.11" - }, - "engines": { - "node": ">=12" - } - }, "node_modules/@redocly/ajv": { "version": "8.11.0", "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.0.tgz", @@ -2954,6 +2685,11 @@ "node": ">=12" } }, + "node_modules/@redocly/config": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.10.1.tgz", + "integrity": "sha512-H3LnKVGzOaxskwJu8pmJYwBOWjP61qOK7TuTrbafqArDVckE06fhA6l0nO4KvBbjLPjy1Al7UnlxOu23V4Nl0w==" + }, "node_modules/@redocly/openapi-cli": { "version": "1.0.0-beta.95", "resolved": "https://registry.npmjs.org/@redocly/openapi-cli/-/openapi-cli-1.0.0-beta.95.tgz", @@ -3099,53 +2835,11 @@ "node": ">=10" } }, - "node_modules/@sigstore/bundle": { + "node_modules/@rtsao/scc": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@sigstore/bundle/-/bundle-1.1.0.tgz", - "integrity": "sha512-PFutXEy0SmQxYI4texPw3dd2KewuNqv7OuK1ZFtY2fM754yhvG2KdgwIhRnoEE2uHdtdGNQ8s0lb94dW9sELog==", - "dev": true, - "dependencies": { - "@sigstore/protobuf-specs": "^0.2.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@sigstore/protobuf-specs": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.2.0.tgz", - "integrity": "sha512-8ZhZKAVfXjIspDWwm3D3Kvj0ddbJ0HqDZ/pOs5cx88HpT8mVsotFrg7H1UMnXOuDHz6Zykwxn4mxG3QLuN+RUg==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@sigstore/sign": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@sigstore/sign/-/sign-1.0.0.tgz", - "integrity": "sha512-INxFVNQteLtcfGmcoldzV6Je0sbbfh9I16DM4yJPw3j5+TFP8X6uIiA18mvpEa9yyeycAKgPmOA3X9hVdVTPUA==", - "dev": true, - "dependencies": { - "@sigstore/bundle": "^1.1.0", - "@sigstore/protobuf-specs": "^0.2.0", - "make-fetch-happen": "^11.0.1" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@sigstore/tuf": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@sigstore/tuf/-/tuf-1.0.3.tgz", - "integrity": "sha512-2bRovzs0nJZFlCN3rXirE4gwxCn97JNjMmwpecqlbgV9WcxX7WRuIrgzx/X7Ib7MYRbyUTpBYE0s2x6AmZXnlg==", - "dev": true, - "dependencies": { - "@sigstore/protobuf-specs": "^0.2.0", - "tuf-js": "^1.1.7" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } + "resolved": "https://registry.npmjs.org/@rtsao/scc/-/scc-1.1.0.tgz", + "integrity": "sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==", + "dev": true }, "node_modules/@sinclair/typebox": { "version": "0.27.8", @@ -3153,18 +2847,6 @@ "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, - "node_modules/@sindresorhus/is": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", - "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sindresorhus/is?sponsor=1" - } - }, "node_modules/@sinonjs/commons": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-3.0.0.tgz", @@ -3189,27 +2871,6 @@ "integrity": "sha512-+9jVqKhRSpsc591z5vX+X5Yyw+he/HCB4iQ/RYxw35CEPaY1gnsNE43nf9n9AaYjAQrTiI/mOwKUKdUs9vf7Xg==", "dev": true }, - "node_modules/@szmarczak/http-timer": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", - "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", - "dev": true, - "dependencies": { - "defer-to-connect": "^2.0.1" - }, - "engines": { - "node": ">=14.16" - } - }, - "node_modules/@tootallnate/once": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-2.0.0.tgz", - "integrity": "sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==", - "dev": true, - "engines": { - "node": ">= 10" - } - }, "node_modules/@tsconfig/node10": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", @@ -3234,56 +2895,10 @@ "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", "dev": true }, - "node_modules/@tufjs/canonical-json": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@tufjs/canonical-json/-/canonical-json-1.0.0.tgz", - "integrity": "sha512-QTnf++uxunWvG2z3UFNzAoQPHxnSXOwtaI3iJ+AohhV+5vONuArPjJE7aPXPVXfXJsqrVbZBu9b81AJoSd09IQ==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@tufjs/models": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@tufjs/models/-/models-1.0.4.tgz", - "integrity": "sha512-qaGV9ltJP0EO25YfFUPhxRVK0evXFIAGicsVXuRim4Ed9cjPxYhNnNJ49SFmbeLgtxpslIkX317IgpfcHPVj/A==", - "dev": true, - "dependencies": { - "@tufjs/canonical-json": "1.0.0", - "minimatch": "^9.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/@tufjs/models/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/@tufjs/models/node_modules/minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/@types/babel__core": { - "version": "7.20.1", - "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.1.tgz", - "integrity": "sha512-aACu/U/omhdk15O4Nfb+fHgH/z3QsfQzpnvRZhYhThms83ZnAOZz7zZAWO7mn2yyNQaA4xTO8GLK3uqFU4bYYw==", + "node_modules/@types/babel__core": { + "version": "7.20.1", + "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.1.tgz", + "integrity": "sha512-aACu/U/omhdk15O4Nfb+fHgH/z3QsfQzpnvRZhYhThms83ZnAOZz7zZAWO7mn2yyNQaA4xTO8GLK3uqFU4bYYw==", "dev": true, "dependencies": { "@babel/parser": "^7.20.7", @@ -3321,18 +2936,6 @@ "@babel/types": "^7.20.7" } }, - "node_modules/@types/cacheable-request": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/@types/cacheable-request/-/cacheable-request-6.0.2.tgz", - "integrity": "sha512-B3xVo+dlKM6nnKTcmm5ZtY/OL8bOAOd2Olee9M1zft65ox50OzjEHW91sDiU9j6cvW8Ejg1/Qkf4xd2kugApUA==", - "dev": true, - "dependencies": { - "@types/http-cache-semantics": "*", - "@types/keyv": "*", - "@types/node": "*", - "@types/responselike": "*" - } - }, "node_modules/@types/conventional-commits-parser": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/@types/conventional-commits-parser/-/conventional-commits-parser-5.0.0.tgz", @@ -3376,12 +2979,6 @@ "@types/node": "*" } }, - "node_modules/@types/http-cache-semantics": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.1.tgz", - "integrity": "sha512-SZs7ekbP8CN0txVG2xVRH6EgKmEm31BOxA07vkFaETzZz1xh+cbt8BcI0slpymvwhx5dlFnQG2rTlPVQn+iRPQ==", - "dev": true - }, "node_modules/@types/istanbul-lib-coverage": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.4.tgz", @@ -3422,12 +3019,6 @@ "integrity": "sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==", "dev": true }, - "node_modules/@types/json-buffer": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@types/json-buffer/-/json-buffer-3.0.0.tgz", - "integrity": "sha512-3YP80IxxFJB4b5tYC2SUPwkg0XQLiu0nWvhRgEatgjf+29IcWO9X1k8xRv5DGssJ/lCrjYTjQPcobJr2yWIVuQ==", - "dev": true - }, "node_modules/@types/json-schema": { "version": "7.0.12", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.12.tgz", @@ -3439,15 +3030,6 @@ "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", "dev": true }, - "node_modules/@types/keyv": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@types/keyv/-/keyv-3.1.4.tgz", - "integrity": "sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/minimatch": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz", @@ -3472,21 +3054,6 @@ "integrity": "sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw==", "dev": true }, - "node_modules/@types/responselike": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.0.tgz", - "integrity": "sha512-85Y2BjiufFzaMIlvJDvTTB8Fxl2xfLo4HgmHzVBz08w4wDePCTjYw66PdrolO0kzli3yam/YCgRufyo1DdQVTA==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/semver-utils": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@types/semver-utils/-/semver-utils-1.1.3.tgz", - "integrity": "sha512-T+YwkslhsM+CeuhYUxyAjWm7mJ5am/K10UX40RuA6k6Lc7eGtq8iY2xOzy7Vq0GOqhl/xZl5l2FwURZMTPTUww==", - "dev": true - }, "node_modules/@types/stack-utils": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.1.tgz", @@ -3515,31 +3082,31 @@ "dev": true }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.11.0.tgz", - "integrity": "sha512-P+qEahbgeHW4JQ/87FuItjBj8O3MYv5gELDzr8QaQ7fsll1gSMTYb6j87MYyxwf3DtD7uGFB9ShwgmCJB5KmaQ==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.4.0.tgz", + "integrity": "sha512-rg8LGdv7ri3oAlenMACk9e+AR4wUV0yrrG+XKsGKOK0EVgeEDqurkXMPILG2836fW4ibokTB5v4b6Z9+GYQDEw==", "dev": true, "dependencies": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "7.11.0", - "@typescript-eslint/type-utils": "7.11.0", - "@typescript-eslint/utils": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0", + "@typescript-eslint/scope-manager": "8.4.0", + "@typescript-eslint/type-utils": "8.4.0", + "@typescript-eslint/utils": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", "ts-api-utils": "^1.3.0" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "@typescript-eslint/parser": "^7.0.0", - "eslint": "^8.56.0" + "@typescript-eslint/parser": "^8.0.0 || ^8.0.0-alpha.0", + "eslint": "^8.57.0 || ^9.0.0" }, "peerDependenciesMeta": { "typescript": { @@ -3548,26 +3115,26 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.11.0.tgz", - "integrity": "sha512-yimw99teuaXVWsBcPO1Ais02kwJ1jmNA1KxE7ng0aT7ndr1pT1wqj0OJnsYVGKKlc4QJai86l/025L6z8CljOg==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.4.0.tgz", + "integrity": "sha512-NHgWmKSgJk5K9N16GIhQ4jSobBoJwrmURaLErad0qlLjrpP5bECYg+wxVTGlGZmJbU03jj/dfnb6V9bw+5icsA==", "dev": true, "dependencies": { - "@typescript-eslint/scope-manager": "7.11.0", - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/typescript-estree": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0", + "@typescript-eslint/scope-manager": "8.4.0", + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/typescript-estree": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0", "debug": "^4.3.4" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.56.0" + "eslint": "^8.57.0 || ^9.0.0" }, "peerDependenciesMeta": { "typescript": { @@ -3576,16 +3143,16 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.11.0.tgz", - "integrity": "sha512-27tGdVEiutD4POirLZX4YzT180vevUURJl4wJGmm6TrQoiYwuxTIY98PBp6L2oN+JQxzE0URvYlzJaBHIekXAw==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.4.0.tgz", + "integrity": "sha512-n2jFxLeY0JmKfUqy3P70rs6vdoPjHK8P/w+zJcV3fk0b0BwRXC/zxRTEnAsgYT7MwdQDt/ZEbtdzdVC+hcpF0A==", "dev": true, "dependencies": { - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0" + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", @@ -3593,26 +3160,23 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.11.0.tgz", - "integrity": "sha512-WmppUEgYy+y1NTseNMJ6mCFxt03/7jTOy08bcg7bxJJdsM4nuhnchyBbE8vryveaJUf62noH7LodPSo5Z0WUCg==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.4.0.tgz", + "integrity": "sha512-pu2PAmNrl9KX6TtirVOrbLPLwDmASpZhK/XU7WvoKoCUkdtq9zF7qQ7gna0GBZFN0hci0vHaSusiL2WpsQk37A==", "dev": true, "dependencies": { - "@typescript-eslint/typescript-estree": "7.11.0", - "@typescript-eslint/utils": "7.11.0", + "@typescript-eslint/typescript-estree": "8.4.0", + "@typescript-eslint/utils": "8.4.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, - "peerDependencies": { - "eslint": "^8.56.0" - }, "peerDependenciesMeta": { "typescript": { "optional": true @@ -3620,12 +3184,12 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.11.0.tgz", - "integrity": "sha512-MPEsDRZTyCiXkD4vd3zywDCifi7tatc4K37KqTprCvaXptP7Xlpdw0NR2hRJTetG5TxbWDB79Ys4kLmHliEo/w==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.4.0.tgz", + "integrity": "sha512-T1RB3KQdskh9t3v/qv7niK6P8yvn7ja1mS7QK7XfRVL6wtZ8/mFs/FHf4fKvTA0rKnqnYxl/uHFNbnEt0phgbw==", "dev": true, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", @@ -3633,22 +3197,22 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.11.0.tgz", - "integrity": "sha512-cxkhZ2C/iyi3/6U9EPc5y+a6csqHItndvN/CzbNXTNrsC3/ASoYQZEt9uMaEp+xFNjasqQyszp5TumAVKKvJeQ==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.4.0.tgz", + "integrity": "sha512-kJ2OIP4dQw5gdI4uXsaxUZHRwWAGpREJ9Zq6D5L0BweyOrWsL6Sz0YcAZGWhvKnH7fm1J5YFE1JrQL0c9dd53A==", "dev": true, "dependencies": { - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0", + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0", "debug": "^4.3.4", - "globby": "^11.1.0", + "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", "ts-api-utils": "^1.3.0" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", @@ -3670,9 +3234,9 @@ } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { - "version": "9.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz", - "integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==", + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", "dev": true, "dependencies": { "brace-expansion": "^2.0.1" @@ -3685,38 +3249,38 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.11.0.tgz", - "integrity": "sha512-xlAWwPleNRHwF37AhrZurOxA1wyXowW4PqVXZVUNCLjB48CqdPJoJWkrpH2nij9Q3Lb7rtWindtoXwxjxlKKCA==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.4.0.tgz", + "integrity": "sha512-swULW8n1IKLjRAgciCkTCafyTHHfwVQFt8DovmaF69sKbOxTSFMmIZaSHjqO9i/RV0wIblaawhzvtva8Nmm7lQ==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "7.11.0", - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/typescript-estree": "7.11.0" + "@typescript-eslint/scope-manager": "8.4.0", + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/typescript-estree": "8.4.0" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", "url": "https://opencollective.com/typescript-eslint" }, "peerDependencies": { - "eslint": "^8.56.0" + "eslint": "^8.57.0 || ^9.0.0" } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.11.0.tgz", - "integrity": "sha512-7syYk4MzjxTEk0g/w3iqtgxnFQspDJfn6QKD36xMuuhTzjcxY7F8EmBLnALjVyaOF1/bVocu3bS/2/F7rXrveQ==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.4.0.tgz", + "integrity": "sha512-zTQD6WLNTre1hj5wp09nBIDiOc2U5r/qmzo7wxPn4ZgAjHql09EofqhF9WF+fZHzL5aCyaIpPcT2hyxl73kr9A==", "dev": true, "dependencies": { - "@typescript-eslint/types": "7.11.0", + "@typescript-eslint/types": "8.4.0", "eslint-visitor-keys": "^3.4.3" }, "engines": { - "node": "^18.18.0 || >=20.0.0" + "node": "^18.18.0 || ^20.9.0 || >=21.1.0" }, "funding": { "type": "opencollective", @@ -3729,12 +3293,6 @@ "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", "dev": true }, - "node_modules/abbrev": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", - "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", - "dev": true - }, "node_modules/accepts": { "version": "1.3.8", "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", @@ -3785,40 +3343,14 @@ "dev": true }, "node_modules/agent-base": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", - "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", - "dev": true, - "dependencies": { - "debug": "4" - }, - "engines": { - "node": ">= 6.0.0" - } - }, - "node_modules/agentkeepalive": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-4.5.0.tgz", - "integrity": "sha512-5GG/5IbQQpC9FpkRGsSvZI5QYeSCzlJHdpBQntCsuTOxhKD8lqKhrleg2Yi7yvMIf82Ycmmqln9U8V9qwEiJew==", - "dev": true, - "dependencies": { - "humanize-ms": "^1.2.1" - }, - "engines": { - "node": ">= 8.0.0" - } - }, - "node_modules/aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", - "dev": true, + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz", + "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==", "dependencies": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" + "debug": "^4.3.4" }, "engines": { - "node": ">=8" + "node": ">= 14" } }, "node_modules/ajv": { @@ -3837,44 +3369,6 @@ "url": "https://github.com/sponsors/epoberezkin" } }, - "node_modules/ansi-align": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", - "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", - "dev": true, - "dependencies": { - "string-width": "^4.1.0" - } - }, - "node_modules/ansi-align/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/ansi-align/node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/ansi-align/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/ansi-colors": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", @@ -3947,25 +3441,6 @@ "node": ">= 8" } }, - "node_modules/aproba": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/aproba/-/aproba-2.0.0.tgz", - "integrity": "sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ==", - "dev": true - }, - "node_modules/are-we-there-yet": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-3.0.1.tgz", - "integrity": "sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==", - "dev": true, - "dependencies": { - "delegates": "^1.0.0", - "readable-stream": "^3.6.0" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, "node_modules/arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -3978,13 +3453,16 @@ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" }, "node_modules/array-buffer-byte-length": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.0.tgz", - "integrity": "sha512-LPuwb2P+NrQw3XhxGc36+XSvuBPopovXYTR9Ew++Du9Yb/bx5AzBfrIsBoj0EZUifjQU+sHL21sseZ3jerWO/A==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "is-array-buffer": "^3.0.1" + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -3997,15 +3475,16 @@ "dev": true }, "node_modules/array-includes": { - "version": "3.1.7", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.7.tgz", - "integrity": "sha512-dlcsNBIiWhPkHdOEEKnehA+RNUWDc4UqFtnIXU4uuYDPtA4LDkr7qip2p0VvFAEXNDr0yWZ9PJyIRiGjRLQzwQ==", + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "get-intrinsic": "^1.2.1", + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", "is-string": "^1.0.7" }, "engines": { @@ -4015,26 +3494,18 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/array-union": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", - "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/array.prototype.findlastindex": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.3.tgz", - "integrity": "sha512-LzLoiOMAxvy+Gd3BAq3B7VeIgPdo+Q8hthvKtXybMvRV0jrXfJM/t8mw7nNlpEcVlVUnCnM2KSX4XU5HmpodOA==", + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "es-shim-unscopables": "^1.0.0", - "get-intrinsic": "^1.2.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -4080,17 +3551,18 @@ } }, "node_modules/arraybuffer.prototype.slice": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.2.tgz", - "integrity": "sha512-yMBKppFur/fbHu9/6USUe03bZ4knMYiwFBcyiaXB8Go0qNehwX6inYPzK9U0NeQvGxKthcmHcaR8P5MStSRBAw==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", "dev": true, "dependencies": { - "array-buffer-byte-length": "^1.0.0", - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "get-intrinsic": "^1.2.1", - "is-array-buffer": "^3.0.2", + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", "is-shared-array-buffer": "^1.0.2" }, "engines": { @@ -4155,9 +3627,9 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, "node_modules/audit-ci": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/audit-ci/-/audit-ci-7.0.0.tgz", - "integrity": "sha512-sdH5/9EYhmfLdtJpUE3npkyN435b5g5RGTQku5UoALyl3GZEwLeN5KD2QlzZ/oDWbGVOro+VLNohoIN6ucz+2Q==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/audit-ci/-/audit-ci-7.1.0.tgz", + "integrity": "sha512-PjjEejlST57S/aDbeWLic0glJ8CNl/ekY3kfGFPMrPkmuaYaDKcMH0F9x9yS9Vp6URhuefSCubl/G0Y2r6oP0g==", "dev": true, "dependencies": { "cross-spawn": "^7.0.3", @@ -4178,10 +3650,13 @@ } }, "node_modules/available-typed-arrays": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz", - "integrity": "sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", "dev": true, + "dependencies": { + "possible-typed-array-names": "^1.0.0" + }, "engines": { "node": ">= 0.4" }, @@ -4309,120 +3784,6 @@ "node": ">=8" } }, - "node_modules/boxen": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.0.0.tgz", - "integrity": "sha512-j//dBVuyacJbvW+tvZ9HuH03fZ46QcaKvvhZickZqtB271DxJ7SNRSNxrV/dZX0085m7hISRZWbzWlJvx/rHSg==", - "dev": true, - "dependencies": { - "ansi-align": "^3.0.1", - "camelcase": "^7.0.0", - "chalk": "^5.0.1", - "cli-boxes": "^3.0.0", - "string-width": "^5.1.2", - "type-fest": "^2.13.0", - "widest-line": "^4.0.1", - "wrap-ansi": "^8.0.1" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/boxen/node_modules/ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/boxen/node_modules/ansi-styles": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.1.0.tgz", - "integrity": "sha512-VbqNsoz55SYGczauuup0MFUyXNQviSpFTj1RQtFzmQLk18qbVSpTFFGMT293rmDaQuKCT6InmbuEyUne4mTuxQ==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-styles?sponsor=1" - } - }, - "node_modules/boxen/node_modules/camelcase": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.0.tgz", - "integrity": "sha512-JToIvOmz6nhGsUhAYScbo2d6Py5wojjNfoxoc2mEVLUdJ70gJK2gnd+ABY1Tc3sVMyK7QDPtN0T/XdlCQWITyQ==", - "dev": true, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/boxen/node_modules/chalk": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.0.1.tgz", - "integrity": "sha512-Fo07WOYGqMfCWHOzSXOt2CxDbC6skS/jO9ynEcmpANMoPrD+W1r1K6Vx7iNm+AQmETU1Xr2t+n8nzkV9t6xh3w==", - "dev": true, - "engines": { - "node": "^12.17.0 || ^14.13 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/boxen/node_modules/strip-ansi": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz", - "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==", - "dev": true, - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/boxen/node_modules/type-fest": { - "version": "2.16.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.16.0.tgz", - "integrity": "sha512-qpaThT2HQkFb83gMOrdKVsfCN7LKxP26Yq+smPzY1FqoHRjqmjqHXA7n5Gkxi8efirtbeEUxzfEdePthQWCuHw==", - "dev": true, - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/boxen/node_modules/wrap-ansi": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.0.1.tgz", - "integrity": "sha512-QFF+ufAqhoYHvoHdajT/Po7KoXVBPXS2bgjIam5isfWJPfIOnQZ50JtUiVvCv/sjgacf3yRrt2ZKUZ/V4itN4g==", - "dev": true, - "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -4610,6 +3971,7 @@ "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", "integrity": "sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ==", "dev": true, + "peer": true, "dependencies": { "semver": "^7.0.0" } @@ -4623,155 +3985,22 @@ "node": ">= 0.8" } }, - "node_modules/cacache": { - "version": "17.1.4", - "resolved": "https://registry.npmjs.org/cacache/-/cacache-17.1.4.tgz", - "integrity": "sha512-/aJwG2l3ZMJ1xNAnqbMpA40of9dj/pIH3QfiuQSqjfPJF747VR0J/bHn+/KdNnHKc6XQcWt/AfRSBft82W1d2A==", - "dev": true, + "node_modules/call-bind": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", "dependencies": { - "@npmcli/fs": "^3.1.0", - "fs-minipass": "^3.0.0", - "glob": "^10.2.2", - "lru-cache": "^7.7.1", - "minipass": "^7.0.3", - "minipass-collect": "^1.0.2", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "p-map": "^4.0.0", - "ssri": "^10.0.0", - "tar": "^6.1.11", - "unique-filename": "^3.0.0" + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" }, "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/cacache/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/cacache/node_modules/glob": { - "version": "10.3.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.3.tgz", - "integrity": "sha512-92vPiMb/iqpmEgsOoIDvTjc50wf9CCCvMzsi6W0JLPeUKE8TWP1a73PgqSrqy7iAZxaSD1YdzU7QZR5LF51MJw==", - "dev": true, - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^2.0.3", - "minimatch": "^9.0.1", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0", - "path-scurry": "^1.10.1" - }, - "bin": { - "glob": "dist/cjs/src/bin.js" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/cacache/node_modules/lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true, - "engines": { - "node": ">=12" - } - }, - "node_modules/cacache/node_modules/minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/cacache/node_modules/minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true, - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, - "node_modules/cacheable-lookup": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-6.0.4.tgz", - "integrity": "sha512-mbcDEZCkv2CZF4G01kr8eBd/5agkt9oCqz75tJMSIsquvRZ2sL6Hi5zGVKi/0OSC9oO1GHfJ2AV0ZIOY9vye0A==", - "dev": true, - "engines": { - "node": ">=10.6.0" - } - }, - "node_modules/cacheable-request": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.2.tgz", - "integrity": "sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew==", - "dev": true, - "dependencies": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^4.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^6.0.1", - "responselike": "^2.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/cacheable-request/node_modules/get-stream": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", - "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", - "dev": true, - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/cacheable-request/node_modules/lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/call-bind": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.5.tgz", - "integrity": "sha512-C3nQxfFZxFRVoJoGKKI8y3MOEo129NQ+FgQ08iye+Mk4zNZZGdjfs06bVTr+DBSlA66Q2VEcMki/cUCP4SercQ==", - "dependencies": { - "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.1", - "set-function-length": "^1.1.1" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/call-me-maybe": { @@ -4855,6 +4084,11 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, + "node_modules/change-case": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", + "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==" + }, "node_modules/char-regex": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", @@ -4891,15 +4125,6 @@ "fsevents": "~2.3.2" } }, - "node_modules/chownr": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", - "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", - "dev": true, - "engines": { - "node": ">=10" - } - }, "node_modules/ci-info": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.3.1.tgz", @@ -4918,86 +4143,21 @@ "integrity": "sha512-CSbhY4cFEJRe6/GQzIk5qXZ4Jeg5pcsP7b5peFSDpffpe1cqjASH/n9UTjBwOp6XpMSTwQ8Za2K5V02ueA7Tmw==", "dev": true }, - "node_modules/clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "dev": true, - "engines": { - "node": ">=6" - } - }, - "node_modules/cli-boxes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", - "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/cli-cursor": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-4.0.0.tgz", - "integrity": "sha512-VGtlMu3x/4DOtIUwEkRezxUZ2lBacNJCHash0N0WeZDBS+7Ux1dm3XWAgWYxLJFMMdOeXMHXorshEFhbMSGelg==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-5.0.0.tgz", + "integrity": "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw==", "dev": true, "dependencies": { - "restore-cursor": "^4.0.0" + "restore-cursor": "^5.0.0" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/cli-table3": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.3.tgz", - "integrity": "sha512-w5Jac5SykAeZJKntOxJCrm63Eg5/4dhMWIcuTbo9rpE+brgaSZo0RuNJZeOyMgsUdhDeojvgyQLmjI+K50ZGyg==", - "dev": true, - "dependencies": { - "string-width": "^4.2.0" - }, - "engines": { - "node": "10.* || >= 12.*" - }, - "optionalDependencies": { - "@colors/colors": "1.5.0" - } - }, - "node_modules/cli-table3/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/cli-table3/node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/cli-table3/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/cli-truncate": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/cli-truncate/-/cli-truncate-4.0.0.tgz", @@ -5014,56 +4174,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/cli-truncate/node_modules/ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/cli-truncate/node_modules/emoji-regex": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz", - "integrity": "sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw==", - "dev": true - }, - "node_modules/cli-truncate/node_modules/string-width": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz", - "integrity": "sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw==", - "dev": true, - "dependencies": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", - "strip-ansi": "^7.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/cli-truncate/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, "node_modules/cliui": { "version": "7.0.4", "resolved": "https://registry.npmjs.org/cliui/-/cliui-7.0.4.tgz", @@ -5104,15 +4214,6 @@ "node": ">=8" } }, - "node_modules/clone-response": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/clone-response/-/clone-response-1.0.2.tgz", - "integrity": "sha512-yjLXh88P599UOyPTFX0POsd7WxnbsVsGohcwzHOLspIhhpalPw1BcqED8NblyZLKcGrL8dTgMlcaZxV2jAD41Q==", - "dev": true, - "dependencies": { - "mimic-response": "^1.0.0" - } - }, "node_modules/clsx": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", @@ -5156,15 +4257,6 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, - "node_modules/color-support": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-support/-/color-support-1.1.3.tgz", - "integrity": "sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg==", - "dev": true, - "bin": { - "color-support": "bin.js" - } - }, "node_modules/colorette": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", @@ -5204,19 +4296,6 @@ "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz", "integrity": "sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg==" }, - "node_modules/compress-brotli": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/compress-brotli/-/compress-brotli-1.3.8.tgz", - "integrity": "sha512-lVcQsjhxhIXsuupfy9fmZUFtAIdBmXA7EGY6GBdgZ++qkM9zG4YFT8iU7FoBxzryNDMOpD1HIFHUSX4D87oqhQ==", - "dev": true, - "dependencies": { - "@types/json-buffer": "~3.0.0", - "json-buffer": "~3.0.1" - }, - "engines": { - "node": ">= 12" - } - }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -5238,62 +4317,6 @@ "typedarray": "^0.0.6" } }, - "node_modules/config-chain": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", - "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", - "dev": true, - "dependencies": { - "ini": "^1.3.4", - "proto-list": "~1.2.1" - } - }, - "node_modules/configstore": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", - "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", - "dev": true, - "dependencies": { - "dot-prop": "^6.0.1", - "graceful-fs": "^4.2.6", - "unique-string": "^3.0.0", - "write-file-atomic": "^3.0.3", - "xdg-basedir": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/yeoman/configstore?sponsor=1" - } - }, - "node_modules/configstore/node_modules/dot-prop": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", - "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", - "dev": true, - "dependencies": { - "is-obj": "^2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/configstore/node_modules/write-file-atomic": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", - "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", - "dev": true, - "dependencies": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } - }, "node_modules/connect": { "version": "3.6.6", "resolved": "https://registry.npmjs.org/connect/-/connect-3.6.6.tgz", @@ -5333,12 +4356,6 @@ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", "dev": true }, - "node_modules/console-control-strings": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", - "integrity": "sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==", - "dev": true - }, "node_modules/conventional-changelog": { "version": "3.1.25", "resolved": "https://registry.npmjs.org/conventional-changelog/-/conventional-changelog-3.1.25.tgz", @@ -5878,33 +4895,6 @@ "node": ">= 8" } }, - "node_modules/crypto-random-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", - "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", - "dev": true, - "dependencies": { - "type-fest": "^1.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/crypto-random-string/node_modules/type-fest": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", - "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/css-color-keywords": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/css-color-keywords/-/css-color-keywords-1.0.0.tgz", @@ -5940,22 +4930,72 @@ "node": ">=8" } }, - "node_modules/dateformat": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-3.0.3.tgz", - "integrity": "sha512-jyCETtSl3VMZMWeRo7iY1FL19ges1t55hMo5yaam4Jrsm5EPL89UQkoQRyiI+Yf4k8r2ZpdngkV8hr1lIdjb3Q==", + "node_modules/data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/dateformat": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-3.0.3.tgz", + "integrity": "sha512-jyCETtSl3VMZMWeRo7iY1FL19ges1t55hMo5yaam4Jrsm5EPL89UQkoQRyiI+Yf4k8r2ZpdngkV8hr1lIdjb3Q==", "dev": true, "engines": { "node": "*" } }, "node_modules/debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", - "dev": true, + "version": "4.3.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", + "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", "dependencies": { - "ms": "2.1.2" + "ms": "^2.1.3" }, "engines": { "node": ">=6.0" @@ -6003,33 +5043,6 @@ "integrity": "sha512-m8FnyHXV1QX+S1cl+KPFDIl6NMkxtKsy6+U/aYyjrOqWMuwAwYWu7ePqrsUHtDR5Y8Yk2pi/KIDSgF+vT4cPOQ==", "dev": true }, - "node_modules/decompress-response": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", - "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", - "dev": true, - "dependencies": { - "mimic-response": "^3.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/decompress-response/node_modules/mimic-response": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", - "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/dedent": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.5.1.tgz", @@ -6044,15 +5057,6 @@ } } }, - "node_modules/deep-extend": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true, - "engines": { - "node": ">=4.0.0" - } - }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -6068,26 +5072,20 @@ "node": ">=0.10.0" } }, - "node_modules/defer-to-connect": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", - "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", - "dev": true, - "engines": { - "node": ">=10" - } - }, "node_modules/define-data-property": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.1.tgz", - "integrity": "sha512-E7uGkTzkk1d0ByLeSc6ZsFS79Axg+m1P/VsgYsxHgiuc3tFSj+MjMIwe90FC4lOAZzNBdY7kkO2P2wKdsQ1vgQ==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", "dependencies": { - "get-intrinsic": "^1.2.1", - "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.0" + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" }, "engines": { "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, "node_modules/define-properties": { @@ -6115,12 +5113,6 @@ "node": ">=0.4.0" } }, - "node_modules/delegates": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delegates/-/delegates-1.0.0.tgz", - "integrity": "sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==", - "dev": true - }, "node_modules/depd": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", @@ -6167,9 +5159,9 @@ } }, "node_modules/diff": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", - "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-7.0.0.tgz", + "integrity": "sha512-PJWHUb1RFevKCwaFA9RlG5tCd+FO5iRh9A8HEtkmBH2Li03iJriB6m6JIN4rGz3K3JLawI7/veA1xzRKP6ISBw==", "dev": true, "engines": { "node": ">=0.3.1" @@ -6184,18 +5176,6 @@ "node": "^14.15.0 || ^16.10.0 || >=18.0.0" } }, - "node_modules/dir-glob": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", - "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", - "dev": true, - "dependencies": { - "path-type": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -6306,12 +5286,6 @@ "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", "dev": true }, - "node_modules/eastasianwidth": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true - }, "node_modules/easy-extender": { "version": "2.3.4", "resolved": "https://registry.npmjs.org/easy-extender/-/easy-extender-2.3.4.tgz", @@ -6342,6 +5316,21 @@ "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", "dev": true }, + "node_modules/ejs": { + "version": "3.1.10", + "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", + "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", + "dev": true, + "dependencies": { + "jake": "^10.8.5" + }, + "bin": { + "ejs": "bin/cli.js" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/electron-to-chromium": { "version": "1.4.247", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.247.tgz", @@ -6361,9 +5350,9 @@ } }, "node_modules/emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", + "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", "dev": true }, "node_modules/encodeurl": { @@ -6380,19 +5369,11 @@ "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", "optional": true, + "peer": true, "dependencies": { "iconv-lite": "^0.6.2" } }, - "node_modules/end-of-stream": { - "version": "1.4.4", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", - "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", - "dev": true, - "dependencies": { - "once": "^1.4.0" - } - }, "node_modules/engine.io": { "version": "6.5.3", "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.5.3.tgz", @@ -6479,9 +5460,9 @@ } }, "node_modules/enhanced-resolve": { - "version": "5.13.0", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.13.0.tgz", - "integrity": "sha512-eyV8f0y1+bzyfh8xAwW/WTSZpLbjhqc4ne9eGSH4Zo2ejdyiNG9pU6mf9DG8a7+Auk6MFTlNOT4Y2y/9k8GKVg==", + "version": "5.17.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.17.1.tgz", + "integrity": "sha512-LMHl3dXhTcfv8gM4kEzIUeTQ+7fpdA0l2tUf34BddXPkz2A5xJ5L/Pchd5BL6rdccM9QGvu0sWZzK1Z1t4wwyg==", "dev": true, "dependencies": { "graceful-fs": "^4.2.4", @@ -6500,11 +5481,17 @@ "node": ">=6" } }, - "node_modules/err-code": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", - "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==", - "dev": true + "node_modules/environment": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/environment/-/environment-1.1.0.tgz", + "integrity": "sha512-xUtoPkMggbz0MPyPiIWr1Kp4aeWJjDZ6SMvURhimjdZgsRuDplF5/s9hcgGhyXMhs+6vpnuoiZ2kFiu3FMnS8Q==", + "dev": true, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } }, "node_modules/error-ex": { "version": "1.3.2", @@ -6516,50 +5503,57 @@ } }, "node_modules/es-abstract": { - "version": "1.22.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.22.3.tgz", - "integrity": "sha512-eiiY8HQeYfYH2Con2berK+To6GrK2RxbPawDkGq4UiCQQfZHb6wX9qQqkbpPqaxQFcl8d9QzZqo0tGE0VcrdwA==", - "dev": true, - "dependencies": { - "array-buffer-byte-length": "^1.0.0", - "arraybuffer.prototype.slice": "^1.0.2", - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.5", - "es-set-tostringtag": "^2.0.1", + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "dev": true, + "dependencies": { + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", "es-to-primitive": "^1.2.1", "function.prototype.name": "^1.1.6", - "get-intrinsic": "^1.2.2", - "get-symbol-description": "^1.0.0", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", "globalthis": "^1.0.3", "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.0", - "has-proto": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", "has-symbols": "^1.0.3", - "hasown": "^2.0.0", - "internal-slot": "^1.0.5", - "is-array-buffer": "^3.0.2", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", "is-callable": "^1.2.7", - "is-negative-zero": "^2.0.2", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.2", + "is-shared-array-buffer": "^1.0.3", "is-string": "^1.0.7", - "is-typed-array": "^1.1.12", + "is-typed-array": "^1.1.13", "is-weakref": "^1.0.2", "object-inspect": "^1.13.1", "object-keys": "^1.1.1", - "object.assign": "^4.1.4", - "regexp.prototype.flags": "^1.5.1", - "safe-array-concat": "^1.0.1", - "safe-regex-test": "^1.0.0", - "string.prototype.trim": "^1.2.8", - "string.prototype.trimend": "^1.0.7", - "string.prototype.trimstart": "^1.0.7", - "typed-array-buffer": "^1.0.0", - "typed-array-byte-length": "^1.0.0", - "typed-array-byte-offset": "^1.0.0", - "typed-array-length": "^1.0.4", + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", "unbox-primitive": "^1.0.2", - "which-typed-array": "^1.1.13" + "which-typed-array": "^1.1.15" }, "engines": { "node": ">= 0.4" @@ -6568,15 +5562,46 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dependencies": { + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "dependencies": { + "es-errors": "^1.3.0" + }, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/es-set-tostringtag": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.2.tgz", - "integrity": "sha512-BuDyupZt65P9D2D2vA/zqcI3G5xRsklm5N3xCwuiy+/vKy8i0ifdsQP1sLgO4tZDSCaQUSnmC48khknGMV3D2Q==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", "dev": true, "dependencies": { - "get-intrinsic": "^1.2.2", - "has-tostringtag": "^1.0.0", - "hasown": "^2.0.0" + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" }, "engines": { "node": ">= 0.4" @@ -6623,18 +5648,6 @@ "node": ">=6" } }, - "node_modules/escape-goat": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", - "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/escape-html": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", @@ -6770,17 +5783,18 @@ } }, "node_modules/eslint-import-resolver-typescript": { - "version": "3.6.1", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-3.6.1.tgz", - "integrity": "sha512-xgdptdoi5W3niYeuQxKmzVDTATvLYqhpwmykwsh7f6HIOStGWEIL9iqZgQDF9u9OEzrRwR8no5q2VT+bjAujTg==", + "version": "3.6.3", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-3.6.3.tgz", + "integrity": "sha512-ud9aw4szY9cCT1EWWdGv1L1XR6hh2PaRWif0j2QjQ0pgTY/69iw+W0Z4qZv5wHahOl8isEr+k/JnyAqNQkLkIA==", "dev": true, "dependencies": { - "debug": "^4.3.4", - "enhanced-resolve": "^5.12.0", - "eslint-module-utils": "^2.7.4", - "fast-glob": "^3.3.1", - "get-tsconfig": "^4.5.0", - "is-core-module": "^2.11.0", + "@nolyfill/is-core-module": "1.0.39", + "debug": "^4.3.5", + "enhanced-resolve": "^5.15.0", + "eslint-module-utils": "^2.8.1", + "fast-glob": "^3.3.2", + "get-tsconfig": "^4.7.5", + "is-bun-module": "^1.0.2", "is-glob": "^4.0.3" }, "engines": { @@ -6791,13 +5805,22 @@ }, "peerDependencies": { "eslint": "*", - "eslint-plugin-import": "*" + "eslint-plugin-import": "*", + "eslint-plugin-import-x": "*" + }, + "peerDependenciesMeta": { + "eslint-plugin-import": { + "optional": true + }, + "eslint-plugin-import-x": { + "optional": true + } } }, "node_modules/eslint-module-utils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.8.0.tgz", - "integrity": "sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw==", + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.10.0.tgz", + "integrity": "sha512-/AXiipjFyfLIUj3E4FR5NEGWoGDZHDfcGzWZkwobRc8fwqUAcy9owTk2LIKwNmtYL8Ad9/XfjSXbGHZ9AJWDEg==", "dev": true, "dependencies": { "debug": "^3.2.7" @@ -6879,26 +5902,27 @@ } }, "node_modules/eslint-plugin-import": { - "version": "2.29.1", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz", - "integrity": "sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==", + "version": "2.30.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.30.0.tgz", + "integrity": "sha512-/mHNE9jINJfiD2EKkg1BKyPyUk4zdnT54YgbOgfjSakWT5oyX/qQLVNTkehyfpcMxZXMy1zyonZ2v7hZTX43Yw==", "dev": true, "dependencies": { - "array-includes": "^3.1.7", - "array.prototype.findlastindex": "^1.2.3", + "@rtsao/scc": "^1.1.0", + "array-includes": "^3.1.8", + "array.prototype.findlastindex": "^1.2.5", "array.prototype.flat": "^1.3.2", "array.prototype.flatmap": "^1.3.2", "debug": "^3.2.7", "doctrine": "^2.1.0", "eslint-import-resolver-node": "^0.3.9", - "eslint-module-utils": "^2.8.0", - "hasown": "^2.0.0", - "is-core-module": "^2.13.1", + "eslint-module-utils": "^2.9.0", + "hasown": "^2.0.2", + "is-core-module": "^2.15.1", "is-glob": "^4.0.3", "minimatch": "^3.1.2", - "object.fromentries": "^2.0.7", - "object.groupby": "^1.0.1", - "object.values": "^1.1.7", + "object.fromentries": "^2.0.8", + "object.groupby": "^1.0.3", + "object.values": "^1.2.0", "semver": "^6.3.1", "tsconfig-paths": "^3.15.0" }, @@ -7038,13 +6062,13 @@ } }, "node_modules/eslint-plugin-prettier": { - "version": "5.1.3", - "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.1.3.tgz", - "integrity": "sha512-C9GCVAs4Eq7ZC/XFQHITLiHJxQngdtraXaM+LoUFoFp/lHNl2Zn8f3WQbe9HvTBBQ9YnKFB0/2Ajdqwo5D1EAw==", + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.2.1.tgz", + "integrity": "sha512-gH3iR3g4JfF+yYPaJYkN7jEl9QbweL/YfkoRlNnuIEHEz1vHVlCmWOS+eGGiRuzHQXdJFCOTxRgvju9b8VUmrw==", "dev": true, "dependencies": { "prettier-linter-helpers": "^1.0.0", - "synckit": "^0.8.6" + "synckit": "^0.9.1" }, "engines": { "node": "^14.18.0 || >=16.0.0" @@ -7068,9 +6092,9 @@ } }, "node_modules/eslint-plugin-promise": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.2.0.tgz", - "integrity": "sha512-QmAqwizauvnKOlifxyDj2ObfULpHQawlg/zQdgEixur9vl0CvZGv/LCJV2rtj3210QCoeGBzVMfMXqGAOr/4fA==", + "version": "6.6.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.6.0.tgz", + "integrity": "sha512-57Zzfw8G6+Gq7axm2Pdo3gW/Rx3h9Yywgn61uE/3elTCOePEHVrn2i5CdfBwA1BLK0Q0WqctICIUSqXZW/VprQ==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -7355,12 +6379,6 @@ "node": ">=0.10.0" } }, - "node_modules/exponential-backoff": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/exponential-backoff/-/exponential-backoff-3.1.1.tgz", - "integrity": "sha512-dX7e/LHVJ6W3DE1MHWi9S1EYzDESENfLrYohG2G++ovZrYOkm4Knwa0mc1cn84xJOR4KEU0WSchhLbd0UklbHw==", - "dev": true - }, "node_modules/extend": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", @@ -7381,6 +6399,7 @@ "version": "3.3.2", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "dev": true, "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -7404,12 +6423,6 @@ "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", "dev": true }, - "node_modules/fast-memoize": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/fast-memoize/-/fast-memoize-2.5.2.tgz", - "integrity": "sha512-Ue0LwpDYErFbmNnZSF0UH6eImUwDmogUO1jyE+JbN2gsQz/jICm1Ve7t9QT0rNSsfJt+Hs4/S3GnsDVjL4HVrw==", - "dev": true - }, "node_modules/fast-safe-stringify": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz", @@ -7420,6 +6433,7 @@ "version": "1.13.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, "dependencies": { "reusify": "^1.0.4" } @@ -7469,6 +6483,36 @@ "node": "^10.12.0 || >=12.0.0" } }, + "node_modules/filelist": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz", + "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==", + "dev": true, + "dependencies": { + "minimatch": "^5.0.1" + } + }, + "node_modules/filelist/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/filelist/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/fill-range": { "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", @@ -7583,34 +6627,6 @@ "integrity": "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg==", "dev": true }, - "node_modules/foreground-child": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz", - "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==", - "dev": true, - "dependencies": { - "cross-spawn": "^7.0.0", - "signal-exit": "^4.0.1" - }, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/foreground-child/node_modules/signal-exit": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", - "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true, - "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/form-data": { "version": "2.5.1", "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.5.1.tgz", @@ -7624,12 +6640,6 @@ "node": ">= 0.12" } }, - "node_modules/form-data-encoder": { - "version": "1.7.1", - "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-1.7.1.tgz", - "integrity": "sha512-EFRDrsMm/kyqbTQocNvRXMLjc7Es2Vk+IQFx/YW7hkUH1eBl4J1fqiP34l74Yt0pFLCNpc06fkbVk00008mzjg==", - "dev": true - }, "node_modules/formidable": { "version": "1.2.6", "resolved": "https://registry.npmjs.org/formidable/-/formidable-1.2.6.tgz", @@ -7639,15 +6649,6 @@ "url": "https://ko-fi.com/tunnckoCore/commissions" } }, - "node_modules/fp-and-or": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/fp-and-or/-/fp-and-or-0.1.4.tgz", - "integrity": "sha512-+yRYRhpnFPWXSly/6V4Lw9IfOV26uu30kynGJ03PW+MnjOEQe45RZ141QcS0aJehYBYA50GfCDnsRbFJdhssRw==", - "dev": true, - "engines": { - "node": ">=10" - } - }, "node_modules/fresh": { "version": "0.5.2", "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", @@ -7663,27 +6664,6 @@ "integrity": "sha512-twe20eF1OxVxp/ML/kq2p1uc6KvFK/+vs8WjEbeKmV2He22MKm7YF2ANIt+EOqhJ5L3K/SuuPhk0hWQDjOM23g==", "dev": true }, - "node_modules/fs-minipass": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-3.0.3.tgz", - "integrity": "sha512-XUBA9XClHbnJWSfBzjkm6RvPsyg3sryZt06BEQoXcF7EK/xpGaQYJgQKDJSUH5SGZ76Y7pFx1QBnXz09rU5Fbw==", - "dev": true, - "dependencies": { - "minipass": "^7.0.3" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/fs-minipass/node_modules/minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true, - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -7739,61 +6719,13 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/gauge": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-4.0.4.tgz", - "integrity": "sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==", + "node_modules/gensync": { + "version": "1.0.0-beta.2", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", + "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", "dev": true, - "dependencies": { - "aproba": "^1.0.3 || ^2.0.0", - "color-support": "^1.1.3", - "console-control-strings": "^1.1.0", - "has-unicode": "^2.0.1", - "signal-exit": "^3.0.7", - "string-width": "^4.2.3", - "strip-ansi": "^6.0.1", - "wide-align": "^1.1.5" - }, "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, - "node_modules/gauge/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/gauge/node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/gauge/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/gensync": { - "version": "1.0.0-beta.2", - "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", - "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", - "dev": true, - "engines": { - "node": ">=6.9.0" + "node": ">=6.9.0" } }, "node_modules/get-caller-file": { @@ -7818,15 +6750,19 @@ } }, "node_modules/get-intrinsic": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.2.tgz", - "integrity": "sha512-0gSo4ml/0j98Y3lngkFEot/zhiCeWsbYIlZ+uZOVgzLyLaUw7wxUL+nCTP0XJvJg1AXulJRI3UJi8GsbDuxdGA==", + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", "dependencies": { + "es-errors": "^1.3.0", "function-bind": "^1.1.2", "has-proto": "^1.0.1", "has-symbols": "^1.0.3", "hasown": "^2.0.0" }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -7945,18 +6881,6 @@ "integrity": "sha512-3UBAyM3u4ZBVYDsxOQfJDxEa6XTbpBDrOjp4mf7ExFRt5BKs/QywQQiJsh2B+hxcZLSapWqCRvElUe8DnKcFHA==", "dev": true }, - "node_modules/get-stdin": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz", - "integrity": "sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/get-stream": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", @@ -7970,13 +6894,14 @@ } }, "node_modules/get-symbol-description": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", - "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.1" + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" }, "engines": { "node": ">= 0.4" @@ -7986,10 +6911,13 @@ } }, "node_modules/get-tsconfig": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.5.0.tgz", - "integrity": "sha512-MjhiaIWCJ1sAU4pIQ5i5OfOuHHxVo1oYeNsWTON7jxYkod8pHocXeh+SSbmu5OZZZK73B6cbJ2XADzXehLyovQ==", + "version": "4.8.0", + "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.8.0.tgz", + "integrity": "sha512-Pgba6TExTZ0FJAn1qkJAjIeKoDJ3CsI2ChuLohJnZl/tTU8MVrq3b+2t5UOPfRa4RMsorClBjJALkJUMjG1PAw==", "dev": true, + "dependencies": { + "resolve-pkg-maps": "^1.0.0" + }, "funding": { "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1" } @@ -8084,6 +7012,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, "dependencies": { "is-glob": "^4.0.1" }, @@ -8186,26 +7115,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/globby": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", - "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", - "dev": true, - "dependencies": { - "array-union": "^2.1.0", - "dir-glob": "^3.0.1", - "fast-glob": "^3.2.9", - "ignore": "^5.2.0", - "merge2": "^1.4.1", - "slash": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/gopd": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", @@ -8217,33 +7126,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/got": { - "version": "12.1.0", - "resolved": "https://registry.npmjs.org/got/-/got-12.1.0.tgz", - "integrity": "sha512-hBv2ty9QN2RdbJJMK3hesmSkFTjVIHyIDDbssCKnSmq62edGgImJWD10Eb1k77TiV1bxloxqcFAVK8+9pkhOig==", - "dev": true, - "dependencies": { - "@sindresorhus/is": "^4.6.0", - "@szmarczak/http-timer": "^5.0.1", - "@types/cacheable-request": "^6.0.2", - "@types/responselike": "^1.0.0", - "cacheable-lookup": "^6.0.4", - "cacheable-request": "^7.0.2", - "decompress-response": "^6.0.0", - "form-data-encoder": "1.7.1", - "get-stream": "^6.0.1", - "http2-wrapper": "^2.1.10", - "lowercase-keys": "^3.0.0", - "p-cancelable": "^3.0.0", - "responselike": "^2.0.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sindresorhus/got?sponsor=1" - } - }, "node_modules/graceful-fs": { "version": "4.2.10", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", @@ -8313,20 +7195,20 @@ } }, "node_modules/has-property-descriptors": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.1.tgz", - "integrity": "sha512-VsX8eaIewvas0xnvinAe9bw4WfIeODpGYikiWYLH+dma0Jw6KHYqWiWfhQlgOVK8D6PvjubK5Uc4P0iIhIcNVg==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", "dependencies": { - "get-intrinsic": "^1.2.2" + "es-define-property": "^1.0.0" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/has-proto": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.1.tgz", - "integrity": "sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", "engines": { "node": ">= 0.4" }, @@ -8346,12 +7228,12 @@ } }, "node_modules/has-tostringtag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", - "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", "dev": true, "dependencies": { - "has-symbols": "^1.0.2" + "has-symbols": "^1.0.3" }, "engines": { "node": ">= 0.4" @@ -8360,28 +7242,10 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/has-unicode": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz", - "integrity": "sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ==", - "dev": true - }, - "node_modules/has-yarn": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", - "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", - "dev": true, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/hasown": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.0.tgz", - "integrity": "sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", "dependencies": { "function-bind": "^1.1.2" }, @@ -8407,12 +7271,6 @@ "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", "dev": true }, - "node_modules/http-cache-semantics": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", - "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==", - "dev": true - }, "node_modules/http-errors": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz", @@ -8452,20 +7310,6 @@ "node": ">=8.0.0" } }, - "node_modules/http-proxy-agent": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-5.0.0.tgz", - "integrity": "sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w==", - "dev": true, - "dependencies": { - "@tootallnate/once": "2", - "agent-base": "6", - "debug": "4" - }, - "engines": { - "node": ">= 6" - } - }, "node_modules/http-proxy/node_modules/eventemitter3": { "version": "4.0.7", "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-4.0.7.tgz", @@ -8478,42 +7322,16 @@ "integrity": "sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA==", "dev": true }, - "node_modules/http2-wrapper": { - "version": "2.1.11", - "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.1.11.tgz", - "integrity": "sha512-aNAk5JzLturWEUiuhAN73Jcbq96R7rTitAoXV54FYMatvihnpD2+6PUgU4ce3D/m5VDbw+F5CsyKSF176ptitQ==", - "dev": true, - "dependencies": { - "quick-lru": "^5.1.1", - "resolve-alpn": "^1.2.0" - }, - "engines": { - "node": ">=10.19.0" - } - }, - "node_modules/http2-wrapper/node_modules/quick-lru": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", - "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/https-proxy-agent": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", - "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", - "dev": true, + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", + "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", "dependencies": { - "agent-base": "6", + "agent-base": "^7.0.2", "debug": "4" }, "engines": { - "node": ">= 6" + "node": ">= 14" } }, "node_modules/human-signals": { @@ -8525,22 +7343,13 @@ "node": ">=10.17.0" } }, - "node_modules/humanize-ms": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz", - "integrity": "sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==", - "dev": true, - "dependencies": { - "ms": "^2.0.0" - } - }, "node_modules/husky": { - "version": "9.0.11", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.11.tgz", - "integrity": "sha512-AB6lFlbwwyIqMdHYhwPe+kjOC3Oc5P3nThEoW/AaO2BX3vJDjWPFxYLxokUZOo6RNX20He3AaT8sESs9NJcmEw==", + "version": "9.1.5", + "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.5.tgz", + "integrity": "sha512-rowAVRUBfI0b4+niA4SJMhfQwc107VLkBUgEYYAOQAbqDCnra1nYh83hF/MDmhYs9t9n1E3DuKOrs2LYNC+0Ag==", "dev": true, "bin": { - "husky": "bin.mjs" + "husky": "bin.js" }, "engines": { "node": ">=18" @@ -8554,6 +7363,7 @@ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", "optional": true, + "peer": true, "dependencies": { "safer-buffer": ">= 2.1.2 < 3.0.0" }, @@ -8570,42 +7380,6 @@ "node": ">= 4" } }, - "node_modules/ignore-walk": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-6.0.3.tgz", - "integrity": "sha512-C7FfFoTA+bI10qfeydT8aZbvr91vAEU+2W5BZUlzPec47oNb07SsOfwYrtxuvOYdUApPP/Qlh4DtAO51Ekk2QA==", - "dev": true, - "dependencies": { - "minimatch": "^9.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/ignore-walk/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/ignore-walk/node_modules/minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/immutable": { "version": "3.8.2", "resolved": "https://registry.npmjs.org/immutable/-/immutable-3.8.2.tgz", @@ -8640,15 +7414,6 @@ "node": ">=4" } }, - "node_modules/import-lazy": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", - "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -8696,6 +7461,17 @@ "node": ">=8" } }, + "node_modules/index-to-position": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-0.1.2.tgz", + "integrity": "sha512-MWDKS3AS1bGCHLBA2VLImJz42f7bJh8wQsTGCzI3j519/CASStoDONUBVz2I/VID0MpiX3SGSnbOD2xUalbE5g==", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -8718,12 +7494,12 @@ "dev": true }, "node_modules/internal-slot": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.6.tgz", - "integrity": "sha512-Xj6dv+PsbtwyPpEflsejS+oIZxmMlV44zAhG479uYu89MsjcYOhCFnNyKrkJrihbsiasQyY0afoCl/9BLR65bg==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", "dev": true, "dependencies": { - "get-intrinsic": "^1.2.2", + "es-errors": "^1.3.0", "hasown": "^2.0.0", "side-channel": "^1.0.4" }, @@ -8731,34 +7507,17 @@ "node": ">= 0.4" } }, - "node_modules/ip-address": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-9.0.5.tgz", - "integrity": "sha512-zHtQzGojZXTwZTHQqra+ETKd4Sn3vgi7uBmlPoXVWZqYvuKmtI0l/VZTjqGmJY9x88GGOaZ9+G9ES8hC4T4X8g==", - "dev": true, - "dependencies": { - "jsbn": "1.1.0", - "sprintf-js": "^1.1.3" - }, - "engines": { - "node": ">= 12" - } - }, - "node_modules/ip-address/node_modules/sprintf-js": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.3.tgz", - "integrity": "sha512-Oo+0REFV59/rz3gfJNKQiBlwfHaSESl1pcGyABQsnnIfWOFt6JNj5gCog2U6MLZ//IGYD+nA8nI+mTShREReaA==", - "dev": true - }, "node_modules/is-array-buffer": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.2.tgz", - "integrity": "sha512-y+FyyR/w8vfIRq4eQcM1EYgSTnmHXPqaF+IgzgraytCFq5Xh8lllDVmAZolPJiZttZLeFSINPYMaEJ7/vWUa1w==", + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", "dev": true, "dependencies": { "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.0", - "is-typed-array": "^1.1.10" + "get-intrinsic": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -8810,6 +7569,15 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-bun-module": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bun-module/-/is-bun-module-1.1.0.tgz", + "integrity": "sha512-4mTAVPlrXpaN3jtF0lsnPCMGnq4+qZjVIKq0HCpfcqf8OC1SM5oATCIAPM5V5FN05qp2NNnFndphmdZS9CV3hA==", + "dev": true, + "dependencies": { + "semver": "^7.6.3" + } + }, "node_modules/is-callable": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", @@ -8822,25 +7590,31 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-ci": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", - "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", + "node_modules/is-core-module": { + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", + "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", "dev": true, "dependencies": { - "ci-info": "^3.2.0" + "hasown": "^2.0.2" }, - "bin": { - "is-ci": "bin.js" + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-core-module": { - "version": "2.13.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz", - "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==", + "node_modules/is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", "dev": true, "dependencies": { - "hasown": "^2.0.0" + "is-typed-array": "^1.1.13" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -8865,6 +7639,7 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true, "engines": { "node": ">=0.10.0" } @@ -8894,6 +7669,7 @@ "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, "dependencies": { "is-extglob": "^2.1.1" }, @@ -8901,56 +7677,10 @@ "node": ">=0.10.0" } }, - "node_modules/is-installed-globally": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", - "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", - "dev": true, - "dependencies": { - "global-dirs": "^3.0.0", - "is-path-inside": "^3.0.2" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-installed-globally/node_modules/global-dirs": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.0.tgz", - "integrity": "sha512-v8ho2DS5RiCjftj1nD9NmnfaOzTdud7RRnVd9kFNOjqZbISlx5DQ+OrTkywgd0dIt7oFCvKetZSHoHcP3sDdiA==", - "dev": true, - "dependencies": { - "ini": "2.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-installed-globally/node_modules/ini": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", - "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", - "dev": true, - "engines": { - "node": ">=10" - } - }, - "node_modules/is-lambda": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-lambda/-/is-lambda-1.0.1.tgz", - "integrity": "sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ==", - "dev": true - }, "node_modules/is-negative-zero": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", - "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", "dev": true, "engines": { "node": ">= 0.4" @@ -8959,18 +7689,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-npm": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.0.0.tgz", - "integrity": "sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ==", - "dev": true, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", @@ -9047,14 +7765,17 @@ } }, "node_modules/is-shared-array-buffer": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.2.tgz", - "integrity": "sha512-sqN2UDu1/0y6uvXyStCOzyhAjCSlHceFoMKJW8W9EU9cvic/QdsZ0kEU93HEy3IUEFZIiH/3w+AH/UQbPHNdhA==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2" + "call-bind": "^1.0.7" }, - "funding": { + "engines": { + "node": ">= 0.4" + }, + "funding": { "url": "https://github.com/sponsors/ljharb" } }, @@ -9113,12 +7834,12 @@ } }, "node_modules/is-typed-array": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.12.tgz", - "integrity": "sha512-Z14TF2JNG8Lss5/HMqt0//T9JeHXttXy5pH/DBU4vi98ozO2btxzq9MwYDZYnKwU8nRsz/+GVFVRDq3DkVuSPg==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", "dev": true, "dependencies": { - "which-typed-array": "^1.1.11" + "which-typed-array": "^1.1.14" }, "engines": { "node": ">= 0.4" @@ -9127,12 +7848,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", - "dev": true - }, "node_modules/is-weakref": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", @@ -9145,15 +7860,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-yarn-global": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.0.tgz", - "integrity": "sha512-HneQBCrXGBy15QnaDfcn6OLoU8AQPAa0Qn0IeJR/QCo4E8dNZaGGwxpCwWyEBQC5QvFonP8d6t60iGpAHVAfNA==", - "dev": true, - "engines": { - "node": ">=12" - } - }, "node_modules/isarray": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", @@ -9240,24 +7946,30 @@ "node": ">=8" } }, - "node_modules/jackspeak": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.3.6.tgz", - "integrity": "sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==", + "node_modules/jake": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz", + "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==", "dev": true, "dependencies": { - "@isaacs/cliui": "^8.0.2" - }, - "engines": { - "node": ">=14" + "async": "^3.2.3", + "chalk": "^4.0.2", + "filelist": "^1.0.4", + "minimatch": "^3.1.2" }, - "funding": { - "url": "https://github.com/sponsors/isaacs" + "bin": { + "jake": "bin/cli.js" }, - "optionalDependencies": { - "@pkgjs/parseargs": "^0.11.0" + "engines": { + "node": ">=10" } }, + "node_modules/jake/node_modules/async": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", + "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", + "dev": true + }, "node_modules/jest": { "version": "29.7.0", "resolved": "https://registry.npmjs.org/jest/-/jest-29.7.0.tgz", @@ -9837,9 +8549,9 @@ } }, "node_modules/jiti": { - "version": "1.21.0", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.0.tgz", - "integrity": "sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q==", + "version": "1.21.6", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.6.tgz", + "integrity": "sha512-2yTgeWTWzMWkHu6Jp9NKgePDaYHbntiwvYuuJLbbN9vl7DC9DvXKOB2BC3ZZ92D3cvV/aflH0osDfwpHepQ53w==", "dev": true, "bin": { "jiti": "bin/jiti.js" @@ -9862,8 +8574,7 @@ "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", - "dev": true + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" }, "node_modules/js-yaml": { "version": "4.1.0", @@ -9876,12 +8587,6 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/jsbn": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-1.1.0.tgz", - "integrity": "sha512-4bYVV3aAMtDTTu4+xsDYa6sy9GyJ69/amsu9sYF2zqjiEoZA5xJi3BrfX3uY+/IekIu7MwdObdbDWpoZdBv3/A==", - "dev": true - }, "node_modules/jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", @@ -9894,12 +8599,6 @@ "node": ">=4" } }, - "node_modules/json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true - }, "node_modules/json-parse-better-errors": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", @@ -9912,15 +8611,6 @@ "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", "dev": true }, - "node_modules/json-parse-helpfulerror": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/json-parse-helpfulerror/-/json-parse-helpfulerror-1.0.3.tgz", - "integrity": "sha1-E/FM4C7tTpgSl7ZOueO5MuLdE9w=", - "dev": true, - "dependencies": { - "jju": "^1.1.0" - } - }, "node_modules/json-pointer": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.2.tgz", @@ -10008,12 +8698,6 @@ "node": ">=6" } }, - "node_modules/jsonlines": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/jsonlines/-/jsonlines-0.1.1.tgz", - "integrity": "sha1-T80kbcXQ44aRkHxEqwAveC0dlMw=", - "dev": true - }, "node_modules/jsonparse": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/jsonparse/-/jsonparse-1.3.1.tgz", @@ -10055,16 +8739,6 @@ "node": ">=10" } }, - "node_modules/keyv": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.3.2.tgz", - "integrity": "sha512-kn8WmodVBe12lmHpA6W8OY7SNh6wVR+Z+wZESF4iF5FCazaVXGWOtnbnvX0tMQ1bO+/TmOD9LziuYMvrIIs0xw==", - "dev": true, - "dependencies": { - "compress-brotli": "^1.3.8", - "json-buffer": "3.0.1" - } - }, "node_modules/kind-of": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", @@ -10083,21 +8757,6 @@ "node": ">=6" } }, - "node_modules/latest-version": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", - "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", - "dev": true, - "dependencies": { - "package-json": "^8.1.0" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -10121,9 +8780,9 @@ } }, "node_modules/lilconfig": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.1.tgz", - "integrity": "sha512-O18pf7nyvHTckunPWCV1XUNXU1piu01y2b7ATJ0ppkUkk8ocqVWBrYjJBCwHDjD/ZWcfyrA0P4gKhzWGi5EINQ==", + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.2.tgz", + "integrity": "sha512-eop+wDAvpItUys0FWkHIKeC9ybYrTGbU41U5K7+bttZZeohvnY7M9dZ5kB21GNWiFT2q1OoPTvncPCgSOVO5ow==", "dev": true, "engines": { "node": ">=14" @@ -10145,21 +8804,21 @@ "dev": true }, "node_modules/lint-staged": { - "version": "15.2.5", - "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.5.tgz", - "integrity": "sha512-j+DfX7W9YUvdzEZl3Rk47FhDF6xwDBV5wwsCPw6BwWZVPYJemusQmvb9bRsW23Sqsaa+vRloAWogbK4BUuU2zA==", + "version": "15.2.10", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.10.tgz", + "integrity": "sha512-5dY5t743e1byO19P9I4b3x8HJwalIznL5E1FWYnU6OWw33KxNBSLAc6Cy7F2PsFEO8FKnLwjwm5hx7aMF0jzZg==", "dev": true, "dependencies": { "chalk": "~5.3.0", "commander": "~12.1.0", - "debug": "~4.3.4", + "debug": "~4.3.6", "execa": "~8.0.1", - "lilconfig": "~3.1.1", - "listr2": "~8.2.1", - "micromatch": "~4.0.7", + "lilconfig": "~3.1.2", + "listr2": "~8.2.4", + "micromatch": "~4.0.8", "pidtree": "~0.6.0", "string-argv": "~0.3.2", - "yaml": "~2.4.2" + "yaml": "~2.5.0" }, "bin": { "lint-staged": "bin/lint-staged.js" @@ -10239,19 +8898,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/lint-staged/node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", - "dev": true, - "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - }, - "engines": { - "node": ">=8.6" - } - }, "node_modules/lint-staged/node_modules/mimic-fn": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz", @@ -10331,16 +8977,16 @@ } }, "node_modules/listr2": { - "version": "8.2.1", - "resolved": "https://registry.npmjs.org/listr2/-/listr2-8.2.1.tgz", - "integrity": "sha512-irTfvpib/rNiD637xeevjO2l3Z5loZmuaRi0L0YE5LfijwVY96oyVn0DFD3o/teAok7nfobMG1THvvcHh/BP6g==", + "version": "8.2.4", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-8.2.4.tgz", + "integrity": "sha512-opevsywziHd3zHCVQGAj8zu+Z3yHNkkoYhWIGnq54RrCVwLz0MozotJEDnKsIBLvkfLGN6BLOyAeRrYI0pKA4g==", "dev": true, "dependencies": { "cli-truncate": "^4.0.0", "colorette": "^2.0.20", "eventemitter3": "^5.0.1", - "log-update": "^6.0.0", - "rfdc": "^1.3.1", + "log-update": "^6.1.0", + "rfdc": "^1.4.1", "wrap-ansi": "^9.0.0" }, "engines": { @@ -10377,29 +9023,6 @@ "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", "dev": true }, - "node_modules/listr2/node_modules/emoji-regex": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz", - "integrity": "sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw==", - "dev": true - }, - "node_modules/listr2/node_modules/string-width": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz", - "integrity": "sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw==", - "dev": true, - "dependencies": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", - "strip-ansi": "^7.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/listr2/node_modules/strip-ansi": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", @@ -10581,14 +9204,14 @@ "dev": true }, "node_modules/log-update": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/log-update/-/log-update-6.0.0.tgz", - "integrity": "sha512-niTvB4gqvtof056rRIrTZvjNYE4rCUzO6X/X+kYjd7WFxXeJ0NwEFnRxX6ehkvv3jTwrXnNdtAak5XYZuIyPFw==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/log-update/-/log-update-6.1.0.tgz", + "integrity": "sha512-9ie8ItPR6tjY5uYJh8K/Zrv/RMZ5VOlOWvtZdEHYSTFKZfIBPQa9tOAEeAWhd+AnIneLJ22w5fjOYtoutpWq5w==", "dev": true, "dependencies": { - "ansi-escapes": "^6.2.0", - "cli-cursor": "^4.0.0", - "slice-ansi": "^7.0.0", + "ansi-escapes": "^7.0.0", + "cli-cursor": "^5.0.0", + "slice-ansi": "^7.1.0", "strip-ansi": "^7.1.0", "wrap-ansi": "^9.0.0" }, @@ -10600,12 +9223,15 @@ } }, "node_modules/log-update/node_modules/ansi-escapes": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-6.2.1.tgz", - "integrity": "sha512-4nJ3yixlEthEJ9Rk4vPcdBRkZvQZlYyu8j4/Mqz5sgIkddmEnH2Yj2ZrnP9S3tQOvSNRUIgVNF/1yPpRAGNRig==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-7.0.0.tgz", + "integrity": "sha512-GdYO7a61mR0fOlAsvC9/rIHf7L96sBc6dEWzeOu+KAea5bZyQRPIpojrVoI4AXGJS/ycu/fBTdLrUkA4ODrvjw==", "dev": true, + "dependencies": { + "environment": "^1.0.0" + }, "engines": { - "node": ">=14.16" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -10635,12 +9261,6 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, - "node_modules/log-update/node_modules/emoji-regex": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz", - "integrity": "sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw==", - "dev": true - }, "node_modules/log-update/node_modules/is-fullwidth-code-point": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-5.0.0.tgz", @@ -10672,23 +9292,6 @@ "url": "https://github.com/chalk/slice-ansi?sponsor=1" } }, - "node_modules/log-update/node_modules/string-width": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz", - "integrity": "sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw==", - "dev": true, - "dependencies": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", - "strip-ansi": "^7.1.0" - }, - "engines": { - "node": ">=18" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/log-update/node_modules/strip-ansi": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", @@ -10733,18 +9336,6 @@ "loose-envify": "cli.js" } }, - "node_modules/lowercase-keys": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", - "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", - "dev": true, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", @@ -10784,41 +9375,6 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "node_modules/make-fetch-happen": { - "version": "11.1.1", - "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-11.1.1.tgz", - "integrity": "sha512-rLWS7GCSTcEujjVBs2YqG7Y4643u8ucvCJeSRqiLYhesrDuzeuFIk37xREzAsfQaqzl8b9rNCE4m6J8tvX4Q8w==", - "dev": true, - "dependencies": { - "agentkeepalive": "^4.2.1", - "cacache": "^17.0.0", - "http-cache-semantics": "^4.1.1", - "http-proxy-agent": "^5.0.0", - "https-proxy-agent": "^5.0.0", - "is-lambda": "^1.0.1", - "lru-cache": "^7.7.1", - "minipass": "^5.0.0", - "minipass-fetch": "^3.0.0", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "negotiator": "^0.6.3", - "promise-retry": "^2.0.1", - "socks-proxy-agent": "^7.0.0", - "ssri": "^10.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/make-fetch-happen/node_modules/lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true, - "engines": { - "node": ">=12" - } - }, "node_modules/makeerror": { "version": "1.0.12", "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", @@ -10911,6 +9467,7 @@ "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, "engines": { "node": ">= 8" } @@ -10924,11 +9481,11 @@ } }, "node_modules/micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dependencies": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" }, "engines": { @@ -10972,13 +9529,16 @@ "node": ">=6" } }, - "node_modules/mimic-response": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz", - "integrity": "sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==", + "node_modules/mimic-function": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/mimic-function/-/mimic-function-5.0.1.tgz", + "integrity": "sha512-VP79XUPxV2CigYP3jWwAUFSku2aKqBH7uTAapFWCBqutsbmDo96KY5o8uh6U+/YSIn5OxJnXp73beVkpqMIGhA==", "dev": true, "engines": { - "node": ">=4" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/min-indent": { @@ -11025,289 +9585,111 @@ "node": ">= 6" } }, - "node_modules/minipass": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", - "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", - "dev": true, - "engines": { - "node": ">=8" - } + "node_modules/mitt": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/mitt/-/mitt-1.2.0.tgz", + "integrity": "sha512-r6lj77KlwqLhIUku9UWYes7KJtsczvolZkzp8hbaDPPaE24OmWl5s539Mytlj22siEQKosZ26qCBgda2PKwoJw==", + "dev": true }, - "node_modules/minipass-collect": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-1.0.2.tgz", - "integrity": "sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==", + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", "dev": true, - "dependencies": { - "minipass": "^3.0.0" + "bin": { + "mkdirp": "bin/cmd.js" }, "engines": { - "node": ">= 8" + "node": ">=10" } }, - "node_modules/minipass-collect/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "node_modules/mobx": { + "version": "6.12.0", + "resolved": "https://registry.npmjs.org/mobx/-/mobx-6.12.0.tgz", + "integrity": "sha512-Mn6CN6meXEnMa0a5u6a5+RKrqRedHBhZGd15AWLk9O6uFY4KYHzImdt8JI8WODo1bjTSRnwXhJox+FCUZhCKCQ==", "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mobx" } }, - "node_modules/minipass-fetch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-3.0.4.tgz", - "integrity": "sha512-jHAqnA728uUpIaFm7NWsCnqKT6UqZz7GcI/bDpPATuwYyKwJwW0remxSCxUlKiEty+eopHGa3oc8WxgQ1FFJqg==", + "node_modules/mobx-react": { + "version": "7.6.0", + "resolved": "https://registry.npmjs.org/mobx-react/-/mobx-react-7.6.0.tgz", + "integrity": "sha512-+HQUNuh7AoQ9ZnU6c4rvbiVVl+wEkb9WqYsVDzGLng+Dqj1XntHu79PvEWKtSMoMj67vFp/ZPXcElosuJO8ckA==", "dev": true, "dependencies": { - "minipass": "^7.0.3", - "minipass-sized": "^1.0.3", - "minizlib": "^2.1.2" + "mobx-react-lite": "^3.4.0" }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mobx" }, - "optionalDependencies": { - "encoding": "^0.1.13" - } - }, - "node_modules/minipass-fetch/node_modules/minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true, - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, - "node_modules/minipass-flush": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.5.tgz", - "integrity": "sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==", - "dev": true, - "dependencies": { - "minipass": "^3.0.0" + "peerDependencies": { + "mobx": "^6.1.0", + "react": "^16.8.0 || ^17 || ^18" }, - "engines": { - "node": ">= 8" + "peerDependenciesMeta": { + "react-dom": { + "optional": true + }, + "react-native": { + "optional": true + } } }, - "node_modules/minipass-flush/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "node_modules/mobx-react-lite": { + "version": "3.4.3", + "resolved": "https://registry.npmjs.org/mobx-react-lite/-/mobx-react-lite-3.4.3.tgz", + "integrity": "sha512-NkJREyFTSUXR772Qaai51BnE1voWx56LOL80xG7qkZr6vo8vEaLF3sz1JNUVh+rxmUzxYaqOhfuxTfqUh0FXUg==", "dev": true, - "dependencies": { - "yallist": "^4.0.0" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/mobx" }, - "engines": { - "node": ">=8" + "peerDependencies": { + "mobx": "^6.1.0", + "react": "^16.8.0 || ^17 || ^18" + }, + "peerDependenciesMeta": { + "react-dom": { + "optional": true + }, + "react-native": { + "optional": true + } } }, - "node_modules/minipass-json-stream": { + "node_modules/modify-values": { "version": "1.0.1", - "resolved": "https://registry.npmjs.org/minipass-json-stream/-/minipass-json-stream-1.0.1.tgz", - "integrity": "sha512-ODqY18UZt/I8k+b7rl2AENgbWE8IDYam+undIJONvigAz8KR5GWblsFTEfQs0WODsjbSXWlm+JHEv8Gr6Tfdbg==", + "resolved": "https://registry.npmjs.org/modify-values/-/modify-values-1.0.1.tgz", + "integrity": "sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw==", "dev": true, - "dependencies": { - "jsonparse": "^1.3.1", - "minipass": "^3.0.0" + "engines": { + "node": ">=0.10.0" } }, - "node_modules/minipass-json-stream/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", + "node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + }, + "node_modules/nanoid": { + "version": "3.3.7", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", + "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==", "dev": true, - "dependencies": { - "yallist": "^4.0.0" + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "bin": { + "nanoid": "bin/nanoid.cjs" }, "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-pipeline": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz", - "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==", - "dev": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-pipeline/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-sized": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-1.0.3.tgz", - "integrity": "sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==", - "dev": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minipass-sized/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/minizlib": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", - "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", - "dev": true, - "dependencies": { - "minipass": "^3.0.0", - "yallist": "^4.0.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/minizlib/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/mitt": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/mitt/-/mitt-1.2.0.tgz", - "integrity": "sha512-r6lj77KlwqLhIUku9UWYes7KJtsczvolZkzp8hbaDPPaE24OmWl5s539Mytlj22siEQKosZ26qCBgda2PKwoJw==", - "dev": true - }, - "node_modules/mkdirp": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", - "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", - "dev": true, - "bin": { - "mkdirp": "bin/cmd.js" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/mobx": { - "version": "6.12.0", - "resolved": "https://registry.npmjs.org/mobx/-/mobx-6.12.0.tgz", - "integrity": "sha512-Mn6CN6meXEnMa0a5u6a5+RKrqRedHBhZGd15AWLk9O6uFY4KYHzImdt8JI8WODo1bjTSRnwXhJox+FCUZhCKCQ==", - "dev": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/mobx" - } - }, - "node_modules/mobx-react": { - "version": "7.6.0", - "resolved": "https://registry.npmjs.org/mobx-react/-/mobx-react-7.6.0.tgz", - "integrity": "sha512-+HQUNuh7AoQ9ZnU6c4rvbiVVl+wEkb9WqYsVDzGLng+Dqj1XntHu79PvEWKtSMoMj67vFp/ZPXcElosuJO8ckA==", - "dev": true, - "dependencies": { - "mobx-react-lite": "^3.4.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/mobx" - }, - "peerDependencies": { - "mobx": "^6.1.0", - "react": "^16.8.0 || ^17 || ^18" - }, - "peerDependenciesMeta": { - "react-dom": { - "optional": true - }, - "react-native": { - "optional": true - } - } - }, - "node_modules/mobx-react-lite": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/mobx-react-lite/-/mobx-react-lite-3.4.3.tgz", - "integrity": "sha512-NkJREyFTSUXR772Qaai51BnE1voWx56LOL80xG7qkZr6vo8vEaLF3sz1JNUVh+rxmUzxYaqOhfuxTfqUh0FXUg==", - "dev": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/mobx" - }, - "peerDependencies": { - "mobx": "^6.1.0", - "react": "^16.8.0 || ^17 || ^18" - }, - "peerDependenciesMeta": { - "react-dom": { - "optional": true - }, - "react-native": { - "optional": true - } - } - }, - "node_modules/modify-values": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/modify-values/-/modify-values-1.0.1.tgz", - "integrity": "sha512-xV2bxeN6F7oYjZWTe/YPAy6MN2M+sL4u/Rlm2AHCIVGfo2p1yGmBHQ6vHehl4bRTZBdHu3TSkWdYgkwpYzAGSw==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, - "node_modules/ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==" - }, - "node_modules/nanoid": { - "version": "3.3.7", - "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.7.tgz", - "integrity": "sha512-eSRppjcPIatRIMC1U6UngP8XFcz8MQWGQdt1MTBQ7NaAmvXDfvNxbvWV3x2y6CdEUciCSsDHDQZbhYaB8QEo2g==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/ai" - } - ], - "bin": { - "nanoid": "bin/nanoid.cjs" - }, - "engines": { - "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, "node_modules/native-promise-only": { @@ -11367,31 +9749,6 @@ "node": "4.x || >=6.0.0" } }, - "node_modules/node-gyp": { - "version": "9.4.0", - "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-9.4.0.tgz", - "integrity": "sha512-dMXsYP6gc9rRbejLXmTbVRYjAHw7ppswsKyMxuxJxxOHzluIO1rGp9TOQgjFJ+2MCqcOcQTOPB/8Xwhr+7s4Eg==", - "dev": true, - "dependencies": { - "env-paths": "^2.2.0", - "exponential-backoff": "^3.1.1", - "glob": "^7.1.4", - "graceful-fs": "^4.2.6", - "make-fetch-happen": "^11.0.3", - "nopt": "^6.0.0", - "npmlog": "^6.0.0", - "rimraf": "^3.0.2", - "semver": "^7.3.5", - "tar": "^6.1.2", - "which": "^2.0.2" - }, - "bin": { - "node-gyp": "bin/node-gyp.js" - }, - "engines": { - "node": "^12.13 || ^14.13 || >=16" - } - }, "node_modules/node-int64": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", @@ -11413,21 +9770,6 @@ "integrity": "sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg==", "dev": true }, - "node_modules/nopt": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-6.0.0.tgz", - "integrity": "sha512-ZwLpbTgdhuZUnZzjd7nb1ZV+4DoiC6/sfiVKok72ym/4Tlf+DFdlHYmT2JPmcNNWV6Pi3SDf1kT+A4r9RTuT9g==", - "dev": true, - "dependencies": { - "abbrev": "^1.0.0" - }, - "bin": { - "nopt": "bin/nopt.js" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, "node_modules/normalize-package-data": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-3.0.3.tgz", @@ -11452,342 +9794,18 @@ "node": ">=0.10.0" } }, - "node_modules/normalize-url": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz", - "integrity": "sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/npm-bundled": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-3.0.0.tgz", - "integrity": "sha512-Vq0eyEQy+elFpzsKjMss9kxqb9tG3YHg4dsyWuUENuzvSUWe1TCnW/vV9FkhvBk/brEDoDiVd+M1Btosa6ImdQ==", - "dev": true, - "dependencies": { - "npm-normalize-package-bin": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/npm-check-updates": { - "version": "16.14.20", - "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-16.14.20.tgz", - "integrity": "sha512-sYbIhun4DrjO7NFOTdvs11nCar0etEhZTsEjL47eM0TuiGMhmYughRCxG2SpGRmGAQ7AkwN7bw2lWzoE7q6yOQ==", - "dev": true, - "dependencies": { - "@types/semver-utils": "^1.1.1", - "chalk": "^5.3.0", - "cli-table3": "^0.6.3", - "commander": "^10.0.1", - "fast-memoize": "^2.5.2", - "find-up": "5.0.0", - "fp-and-or": "^0.1.4", - "get-stdin": "^8.0.0", - "globby": "^11.0.4", - "hosted-git-info": "^5.1.0", - "ini": "^4.1.1", - "js-yaml": "^4.1.0", - "json-parse-helpfulerror": "^1.0.3", - "jsonlines": "^0.1.1", - "lodash": "^4.17.21", - "make-fetch-happen": "^11.1.1", - "minimatch": "^9.0.3", - "p-map": "^4.0.0", - "pacote": "15.2.0", - "parse-github-url": "^1.0.2", - "progress": "^2.0.3", - "prompts-ncu": "^3.0.0", - "rc-config-loader": "^4.1.3", - "remote-git-tags": "^3.0.0", - "rimraf": "^5.0.5", - "semver": "^7.5.4", - "semver-utils": "^1.1.4", - "source-map-support": "^0.5.21", - "spawn-please": "^2.0.2", - "strip-ansi": "^7.1.0", - "strip-json-comments": "^5.0.1", - "untildify": "^4.0.0", - "update-notifier": "^6.0.2" - }, - "bin": { - "ncu": "build/src/bin/cli.js", - "npm-check-updates": "build/src/bin/cli.js" - }, - "engines": { - "node": ">=14.14" - } - }, - "node_modules/npm-check-updates/node_modules/ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/npm-check-updates/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/npm-check-updates/node_modules/chalk": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", - "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", - "dev": true, - "engines": { - "node": "^12.17.0 || ^14.13 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, - "node_modules/npm-check-updates/node_modules/commander": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", - "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", - "dev": true, - "engines": { - "node": ">=14" - } - }, - "node_modules/npm-check-updates/node_modules/glob": { - "version": "10.3.10", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.10.tgz", - "integrity": "sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g==", - "dev": true, - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^2.3.5", - "minimatch": "^9.0.1", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0", - "path-scurry": "^1.10.1" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/npm-check-updates/node_modules/hosted-git-info": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-5.1.0.tgz", - "integrity": "sha512-Ek+QmMEqZF8XrbFdwoDjSbm7rT23pCgEMOJmz6GPk/s4yH//RQfNPArhIxbguNxROq/+5lNBwCDHMhA903Kx1Q==", - "dev": true, - "dependencies": { - "lru-cache": "^7.5.1" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, - "node_modules/npm-check-updates/node_modules/ini": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.1.tgz", - "integrity": "sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-check-updates/node_modules/lru-cache": { - "version": "7.14.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.14.0.tgz", - "integrity": "sha512-EIRtP1GrSJny0dqb50QXRUNBxHJhcpxHC++M5tD7RYbvLLn5KVWKsbyswSSqDuU15UFi3bgTQIY8nhDMeF6aDQ==", - "dev": true, - "engines": { - "node": ">=12" - } - }, - "node_modules/npm-check-updates/node_modules/minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "version": "17.1.1", + "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-17.1.1.tgz", + "integrity": "sha512-2aqIzGAEWB7xPf0hKHTkNmUM5jHbn2S5r2/z/7dA5Ij2h/sVYAg9R/uVkaUC3VORPAfBm7pKkCWo6E9clEVQ9A==", "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/npm-check-updates/node_modules/rimraf": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-5.0.5.tgz", - "integrity": "sha512-CqDakW+hMe/Bz202FPEymy68P+G50RfMQK+Qo5YUqc9SPipvbGjCGKd0RSKEelbsfQuw3g5NZDSrlZZAJurH1A==", - "dev": true, - "dependencies": { - "glob": "^10.3.7" - }, "bin": { - "rimraf": "dist/esm/bin.mjs" + "ncu": "build/cli.js", + "npm-check-updates": "build/cli.js" }, "engines": { - "node": ">=14" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/npm-check-updates/node_modules/source-map-support": { - "version": "0.5.21", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", - "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", - "dev": true, - "dependencies": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, - "node_modules/npm-check-updates/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/npm-check-updates/node_modules/strip-json-comments": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-5.0.1.tgz", - "integrity": "sha512-0fk9zBqO67Nq5M/m45qHCJxylV/DhBlIOVExqgOMiCCrzrhU6tCibRXNqE3jwJLftzE9SNuZtYbpzcO+i9FiKw==", - "dev": true, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/npm-install-checks": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/npm-install-checks/-/npm-install-checks-6.2.0.tgz", - "integrity": "sha512-744wat5wAAHsxa4590mWO0tJ8PKxR8ORZsH9wGpQc3nWTzozMAgBN/XyqYw7mg3yqLM8dLwEnwSfKMmXAjF69g==", - "dev": true, - "dependencies": { - "semver": "^7.1.1" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-normalize-package-bin": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-3.0.1.tgz", - "integrity": "sha512-dMxCf+zZ+3zeQZXKxmyuCKlIDPGuv8EF940xbkC4kQVDTtqoh6rJFO+JTKSA6/Rwi0getWmtuy4Itup0AMcaDQ==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-package-arg": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-10.1.0.tgz", - "integrity": "sha512-uFyyCEmgBfZTtrKk/5xDfHp6+MdrqGotX/VoOyEEl3mBwiEE5FlBaePanazJSVMPT7vKepcjYBY2ztg9A3yPIA==", - "dev": true, - "dependencies": { - "hosted-git-info": "^6.0.0", - "proc-log": "^3.0.0", - "semver": "^7.3.5", - "validate-npm-package-name": "^5.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-package-arg/node_modules/hosted-git-info": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-6.1.1.tgz", - "integrity": "sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==", - "dev": true, - "dependencies": { - "lru-cache": "^7.5.1" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-package-arg/node_modules/lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true, - "engines": { - "node": ">=12" - } - }, - "node_modules/npm-packlist": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/npm-packlist/-/npm-packlist-7.0.4.tgz", - "integrity": "sha512-d6RGEuRrNS5/N84iglPivjaJPxhDbZmlbTwTDX2IbcRHG5bZCdtysYMhwiPvcF4GisXHGn7xsxv+GQ7T/02M5Q==", - "dev": true, - "dependencies": { - "ignore-walk": "^6.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-pick-manifest": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/npm-pick-manifest/-/npm-pick-manifest-8.0.2.tgz", - "integrity": "sha512-1dKY+86/AIiq1tkKVD3l0WI+Gd3vkknVGAggsFeBkTvbhMQ1OND/LKkYv4JtXPKUJ8bOTCyLiqEg2P6QNdK+Gg==", - "dev": true, - "dependencies": { - "npm-install-checks": "^6.0.0", - "npm-normalize-package-bin": "^3.0.0", - "npm-package-arg": "^10.0.0", - "semver": "^7.3.5" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/npm-registry-fetch": { - "version": "14.0.5", - "resolved": "https://registry.npmjs.org/npm-registry-fetch/-/npm-registry-fetch-14.0.5.tgz", - "integrity": "sha512-kIDMIo4aBm6xg7jOttupWZamsZRkAqMqwqqbVXnUqstY5+tapvv6bkH/qMR76jdgV+YljEUCyWx3hRYMrJiAgA==", - "dev": true, - "dependencies": { - "make-fetch-happen": "^11.0.0", - "minipass": "^5.0.0", - "minipass-fetch": "^3.0.0", - "minipass-json-stream": "^1.0.1", - "minizlib": "^2.1.2", - "npm-package-arg": "^10.0.0", - "proc-log": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + "node": "^18.18.0 || >=20.0.0", + "npm": ">=8.12.1" } }, "node_modules/npm-run-path": { @@ -11802,21 +9820,6 @@ "node": ">=8" } }, - "node_modules/npmlog": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-6.0.2.tgz", - "integrity": "sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==", - "dev": true, - "dependencies": { - "are-we-there-yet": "^3.0.0", - "console-control-strings": "^1.1.0", - "gauge": "^4.0.3", - "set-blocking": "^2.0.0" - }, - "engines": { - "node": "^12.13.0 || ^14.15.0 || >=16.0.0" - } - }, "node_modules/oas-kit-common": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz", @@ -11941,13 +9944,13 @@ } }, "node_modules/object.assign": { - "version": "4.1.4", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.4.tgz", - "integrity": "sha512-1mxKf0e58bvyjSCtKYY4sRe9itRk3PJpquJOjeIkz885CczcI4IvJJDLPS72oowuSh+pBxUFROpX+TU++hxhZQ==", + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.4", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", "has-symbols": "^1.0.3", "object-keys": "^1.1.1" }, @@ -11959,14 +9962,15 @@ } }, "node_modules/object.fromentries": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.7.tgz", - "integrity": "sha512-UPbPHML6sL8PI/mOqPwsH4G6iyXcCGzLin8KvEPenOZN5lpCNBZZQ+V62vdjB1mQHrmqGQt5/OJzemUA+KJmEA==", + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -11976,26 +9980,28 @@ } }, "node_modules/object.groupby": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.1.tgz", - "integrity": "sha512-HqaQtqLnp/8Bn4GL16cj+CUYbnpe1bh0TtEaWvybszDG4tgxCJuRpV8VGuvNaI1fAnI4lUJzDG55MXcOH4JZcQ==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "get-intrinsic": "^1.2.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" + }, + "engines": { + "node": ">= 0.4" } }, "node_modules/object.values": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.7.tgz", - "integrity": "sha512-aU6xnDFYT3x17e/f0IiiwlGPTy2jzMySGfUB4fq6z7CV8l85CWHDk5ErhyhpfDHhrOMwGFhSQkhMGHaIotA6Ng==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -12056,19 +10062,79 @@ "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==" }, "node_modules/openapi-typescript": { - "version": "6.7.6", - "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-6.7.6.tgz", - "integrity": "sha512-c/hfooPx+RBIOPM09GSxABOZhYPblDoyaGhqBkD/59vtpN21jEuWKDlM0KYTvqJVlSYjKs0tBcIdeXKChlSPtw==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.4.0.tgz", + "integrity": "sha512-u4iVuTGkzKG4rHFUMA/IFXTks9tYVQzkowZsScMOdzJSvIF10qSNySWHTwnN2fD+MEeWFAM8i1f3IUBlgS92eQ==", "dependencies": { + "@redocly/openapi-core": "^1.16.0", "ansi-colors": "^4.1.3", - "fast-glob": "^3.3.2", - "js-yaml": "^4.1.0", + "change-case": "^5.4.4", + "parse-json": "^8.1.0", "supports-color": "^9.4.0", - "undici": "^5.28.4", "yargs-parser": "^21.1.1" }, "bin": { "openapi-typescript": "bin/cli.js" + }, + "peerDependencies": { + "typescript": "^5.x" + } + }, + "node_modules/openapi-typescript/node_modules/@redocly/openapi-core": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.22.1.tgz", + "integrity": "sha512-pjr456gJzrbwPvBjFKlWOd9nZEcr/dp6XSH0c8ijWGWv5K+V0vpUUy2zaTAVsFAoCydx1miEoOcbLhWQ9WC2nw==", + "dependencies": { + "@redocly/ajv": "^8.11.0", + "@redocly/config": "^0.10.1", + "colorette": "^1.2.0", + "https-proxy-agent": "^7.0.4", + "js-levenshtein": "^1.1.6", + "js-yaml": "^4.1.0", + "lodash.isequal": "^4.5.0", + "minimatch": "^5.0.1", + "node-fetch": "^2.6.1", + "pluralize": "^8.0.0", + "yaml-ast-parser": "0.0.43" + }, + "engines": { + "node": ">=14.19.0", + "npm": ">=7.0.0" + } + }, + "node_modules/openapi-typescript/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/openapi-typescript/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/openapi-typescript/node_modules/parse-json": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.1.0.tgz", + "integrity": "sha512-rum1bPifK5SSar35Z6EKZuYPJx85pkNaFrxBK3mwdfSJ1/WKbYrjoW/zTPSjRRamfmVX1ACBIdFAO0VRErW/EA==", + "dependencies": { + "@babel/code-frame": "^7.22.13", + "index-to-position": "^0.1.2", + "type-fest": "^4.7.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/openapi-typescript/node_modules/supports-color": { @@ -12082,6 +10148,17 @@ "url": "https://github.com/chalk/supports-color?sponsor=1" } }, + "node_modules/openapi-typescript/node_modules/type-fest": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.0.tgz", + "integrity": "sha512-OduNjVJsFbifKb57UqZ2EMP1i4u64Xwow3NYXUtBbD4vIwJdQd4+xl8YDou1dlm4DVrtwT/7Ky8z8WyCULVfxw==", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/openapi-typescript/node_modules/yargs-parser": { "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", @@ -12128,15 +10205,6 @@ "node": ">= 0.8.0" } }, - "node_modules/p-cancelable": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", - "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", - "dev": true, - "engines": { - "node": ">=12.20" - } - }, "node_modules/p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", @@ -12167,21 +10235,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/p-map": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", - "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", - "dev": true, - "dependencies": { - "aggregate-error": "^3.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/p-try": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", @@ -12191,56 +10244,6 @@ "node": ">=6" } }, - "node_modules/package-json": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.0.tgz", - "integrity": "sha512-hySwcV8RAWeAfPsXb9/HGSPn8lwDnv6fabH+obUZKX169QknRkRhPxd1yMubpKDskLFATkl3jHpNtVtDPFA0Wg==", - "dev": true, - "dependencies": { - "got": "^12.1.0", - "registry-auth-token": "^5.0.1", - "registry-url": "^6.0.0", - "semver": "^7.3.7" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/pacote": { - "version": "15.2.0", - "resolved": "https://registry.npmjs.org/pacote/-/pacote-15.2.0.tgz", - "integrity": "sha512-rJVZeIwHTUta23sIZgEIM62WYwbmGbThdbnkt81ravBplQv+HjyroqnLRNH2+sLJHcGZmLRmhPwACqhfTcOmnA==", - "dev": true, - "dependencies": { - "@npmcli/git": "^4.0.0", - "@npmcli/installed-package-contents": "^2.0.1", - "@npmcli/promise-spawn": "^6.0.1", - "@npmcli/run-script": "^6.0.0", - "cacache": "^17.0.0", - "fs-minipass": "^3.0.0", - "minipass": "^5.0.0", - "npm-package-arg": "^10.0.0", - "npm-packlist": "^7.0.0", - "npm-pick-manifest": "^8.0.0", - "npm-registry-fetch": "^14.0.0", - "proc-log": "^3.0.0", - "promise-retry": "^2.0.1", - "read-package-json": "^6.0.0", - "read-package-json-fast": "^3.0.0", - "sigstore": "^1.3.0", - "ssri": "^10.0.0", - "tar": "^6.1.11" - }, - "bin": { - "pacote": "lib/bin.js" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -12250,19 +10253,7 @@ "callsites": "^3.0.0" }, "engines": { - "node": ">=6" - } - }, - "node_modules/parse-github-url": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/parse-github-url/-/parse-github-url-1.0.2.tgz", - "integrity": "sha512-kgBf6avCbO3Cn6+RnzRGLkUsv4ZVqv/VfAYkRsyBcgkshNvVBkRn1FEZcW0Jb+npXQWm2vHPnnOqFteZxRRGNw==", - "dev": true, - "bin": { - "parse-github-url": "cli.js" - }, - "engines": { - "node": ">=0.10.0" + "node": ">=6" } }, "node_modules/parse-json": { @@ -12340,40 +10331,6 @@ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, - "node_modules/path-scurry": { - "version": "1.10.1", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz", - "integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==", - "dev": true, - "dependencies": { - "lru-cache": "^9.1.1 || ^10.0.0", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/path-scurry/node_modules/lru-cache": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.0.1.tgz", - "integrity": "sha512-IJ4uwUTi2qCccrioU6g9g/5rvvVl13bsdczUUcqbciD9iLr095yj8DQKdObriEvuNSx325N1rV1O0sJFszx75g==", - "dev": true, - "engines": { - "node": "14 || >=16.14" - } - }, - "node_modules/path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/pause-stream": { "version": "0.0.11", "resolved": "https://registry.npmjs.org/pause-stream/-/pause-stream-0.0.11.tgz", @@ -12569,6 +10526,15 @@ "npm": ">=1.0.0" } }, + "node_modules/possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, "node_modules/postcss": { "version": "8.4.32", "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.32.tgz", @@ -12613,9 +10579,9 @@ } }, "node_modules/prettier": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.0.tgz", - "integrity": "sha512-J9odKxERhCQ10OC2yb93583f6UnYutOeiV5i0zEDS7UGTdUt0u+y8erxl3lBKvwo/JHyyoEdXjwp4dke9oyZ/g==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", + "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", "dev": true, "bin": { "prettier": "bin/prettier.cjs" @@ -12674,48 +10640,11 @@ "node": ">=6" } }, - "node_modules/proc-log": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-3.0.0.tgz", - "integrity": "sha512-++Vn7NS4Xf9NacaU9Xq3URUuqZETPsf8L4j5/ckhaRYsfPeRyzGw+iDjFhV/Jr3uNmTvvddEJFWh5R1gRgUH8A==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==" }, - "node_modules/progress": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", - "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", - "dev": true, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/promise-inflight": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", - "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", - "dev": true - }, - "node_modules/promise-retry": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", - "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==", - "dev": true, - "dependencies": { - "err-code": "^2.0.2", - "retry": "^0.12.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -12729,28 +10658,6 @@ "node": ">= 6" } }, - "node_modules/prompts-ncu": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/prompts-ncu/-/prompts-ncu-3.0.0.tgz", - "integrity": "sha512-qyz9UxZ5MlPKWVhWrCmSZ1ahm2GVYdjLb8og2sg0IPth1KRuhcggHGuijz0e41dkx35p1t1q3GRISGH7QGALFA==", - "dev": true, - "dependencies": { - "kleur": "^4.0.1", - "sisteransi": "^1.0.5" - }, - "engines": { - "node": ">= 14" - } - }, - "node_modules/prompts-ncu/node_modules/kleur": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", - "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/prop-types": { "version": "15.8.1", "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", @@ -12768,22 +10675,6 @@ "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", "dev": true }, - "node_modules/proto-list": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", - "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", - "dev": true - }, - "node_modules/pump": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "dev": true, - "dependencies": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } - }, "node_modules/punycode": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", @@ -12792,21 +10683,6 @@ "node": ">=6" } }, - "node_modules/pupa": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.1.0.tgz", - "integrity": "sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug==", - "dev": true, - "dependencies": { - "escape-goat": "^4.0.0" - }, - "engines": { - "node": ">=12.20" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/pure-rand": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-6.0.3.tgz", @@ -12851,6 +10727,7 @@ "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, "funding": [ { "type": "github", @@ -12920,42 +10797,6 @@ "node": ">=0.10.0" } }, - "node_modules/rc": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", - "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", - "dev": true, - "dependencies": { - "deep-extend": "^0.6.0", - "ini": "~1.3.0", - "minimist": "^1.2.0", - "strip-json-comments": "~2.0.1" - }, - "bin": { - "rc": "cli.js" - } - }, - "node_modules/rc-config-loader": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/rc-config-loader/-/rc-config-loader-4.1.3.tgz", - "integrity": "sha512-kD7FqML7l800i6pS6pvLyIE2ncbk9Du8Q0gp/4hMPhJU6ZxApkoLcGD8ZeqgiAlfwZ6BlETq6qqe+12DUL207w==", - "dev": true, - "dependencies": { - "debug": "^4.3.4", - "js-yaml": "^4.1.0", - "json5": "^2.2.2", - "require-from-string": "^2.0.2" - } - }, - "node_modules/rc/node_modules/strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/react": { "version": "18.2.0", "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz", @@ -13000,134 +10841,6 @@ "react": "^16.8.0 || ^17.0.0-0 || ^18.0.0" } }, - "node_modules/read-package-json": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/read-package-json/-/read-package-json-6.0.4.tgz", - "integrity": "sha512-AEtWXYfopBj2z5N5PbkAOeNHRPUg5q+Nen7QLxV8M2zJq1ym6/lCz3fYNTCXe19puu2d06jfHhrP7v/S2PtMMw==", - "dev": true, - "dependencies": { - "glob": "^10.2.2", - "json-parse-even-better-errors": "^3.0.0", - "normalize-package-data": "^5.0.0", - "npm-normalize-package-bin": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/read-package-json-fast": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/read-package-json-fast/-/read-package-json-fast-3.0.2.tgz", - "integrity": "sha512-0J+Msgym3vrLOUB3hzQCuZHII0xkNGCtz/HJH9xZshwv9DbDwkw1KaE3gx/e2J5rpEY5rtOy6cyhKOPrkP7FZw==", - "dev": true, - "dependencies": { - "json-parse-even-better-errors": "^3.0.0", - "npm-normalize-package-bin": "^3.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/read-package-json-fast/node_modules/json-parse-even-better-errors": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.0.tgz", - "integrity": "sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/read-package-json/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/read-package-json/node_modules/glob": { - "version": "10.3.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.3.tgz", - "integrity": "sha512-92vPiMb/iqpmEgsOoIDvTjc50wf9CCCvMzsi6W0JLPeUKE8TWP1a73PgqSrqy7iAZxaSD1YdzU7QZR5LF51MJw==", - "dev": true, - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^2.0.3", - "minimatch": "^9.0.1", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0", - "path-scurry": "^1.10.1" - }, - "bin": { - "glob": "dist/cjs/src/bin.js" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/read-package-json/node_modules/hosted-git-info": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-6.1.1.tgz", - "integrity": "sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==", - "dev": true, - "dependencies": { - "lru-cache": "^7.5.1" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/read-package-json/node_modules/json-parse-even-better-errors": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.0.tgz", - "integrity": "sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==", - "dev": true, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/read-package-json/node_modules/lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true, - "engines": { - "node": ">=12" - } - }, - "node_modules/read-package-json/node_modules/minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/read-package-json/node_modules/normalize-package-data": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-5.0.0.tgz", - "integrity": "sha512-h9iPVIfrVZ9wVYQnxFgtw1ugSvGEMOlyPWWtm8BMJhnwyEL/FLbYbTY3V3PpjI/BUK67n9PEWDu6eHzu1fB15Q==", - "dev": true, - "dependencies": { - "hosted-git-info": "^6.0.0", - "is-core-module": "^2.8.1", - "semver": "^7.3.5", - "validate-npm-package-license": "^3.0.4" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/read-pkg": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz", @@ -13367,14 +11080,15 @@ "dev": true }, "node_modules/regexp.prototype.flags": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.1.tgz", - "integrity": "sha512-sy6TXMN+hnP/wMy+ISxg3krXx7BAtWVO4UouuCN/ziM9UEne0euamVNafDfvC83bRNr95y0V5iijeDQFUNpvrg==", + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", + "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "set-function-name": "^2.0.0" + "call-bind": "^1.0.6", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.1" }, "engines": { "node": ">= 0.4" @@ -13395,42 +11109,6 @@ "url": "https://github.com/sponsors/mysticatea" } }, - "node_modules/registry-auth-token": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.0.1.tgz", - "integrity": "sha512-UfxVOj8seK1yaIOiieV4FIP01vfBDLsY0H9sQzi9EbbUdJiuuBjJgLa1DpImXMNPnVkBD4eVxTEXcrZA6kfpJA==", - "dev": true, - "dependencies": { - "@pnpm/npm-conf": "^1.0.4" - }, - "engines": { - "node": ">=14" - } - }, - "node_modules/registry-url": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", - "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", - "dev": true, - "dependencies": { - "rc": "1.2.8" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/remote-git-tags": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/remote-git-tags/-/remote-git-tags-3.0.0.tgz", - "integrity": "sha512-C9hAO4eoEsX+OXA4rla66pXZQ+TLQ8T9dttgQj18yuKlPMTVkIkdYXvlMC55IuUsIkV6DpmQYi10JKFLaU+l7w==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -13477,12 +11155,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/resolve-alpn": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", - "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", - "dev": true - }, "node_modules/resolve-cwd": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", @@ -13504,6 +11176,15 @@ "node": ">=8" } }, + "node_modules/resolve-pkg-maps": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", + "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", + "dev": true, + "funding": { + "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1" + } + }, "node_modules/resolve.exports": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.2.tgz", @@ -13541,62 +11222,63 @@ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", "dev": true }, - "node_modules/responselike": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-2.0.0.tgz", - "integrity": "sha512-xH48u3FTB9VsZw7R+vvgaKeLKzT6jOogbQhEe/jewwnZgzPcnyWui2Av6JpoYZF/91uueC+lqhWqeURw5/qhCw==", + "node_modules/restore-cursor": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-5.1.0.tgz", + "integrity": "sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA==", "dev": true, "dependencies": { - "lowercase-keys": "^2.0.0" - } - }, - "node_modules/responselike/node_modules/lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "dev": true, + "onetime": "^7.0.0", + "signal-exit": "^4.1.0" + }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/restore-cursor": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-4.0.0.tgz", - "integrity": "sha512-I9fPXU9geO9bHOt9pHHOhOkYerIMsmVaWB0rA2AI9ERh/+x/i7MV5HKBNrg+ljO5eoPVgCcnFuRjJ9uH6I/3eg==", + "node_modules/restore-cursor/node_modules/onetime": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-7.0.0.tgz", + "integrity": "sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==", "dev": true, "dependencies": { - "onetime": "^5.1.0", - "signal-exit": "^3.0.2" + "mimic-function": "^5.0.0" }, "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/retry": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", - "integrity": "sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==", + "node_modules/restore-cursor/node_modules/signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", "dev": true, "engines": { - "node": ">= 4" + "node": ">=14" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/reusify": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, "engines": { "iojs": ">=1.0.0", "node": ">=0.10.0" } }, "node_modules/rfdc": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.1.tgz", - "integrity": "sha512-r5a3l5HzYlIC68TpmYKlxWjmOP6wiPJ1vWv2HeLhNsRZMrCkxeqxiHlQ21oXmQ4F3SiryXBHhAD7JZqvOJjFmg==", + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.4.1.tgz", + "integrity": "sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA==", "dev": true }, "node_modules/rimraf": { @@ -13618,6 +11300,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, "funding": [ { "type": "github", @@ -13643,13 +11326,13 @@ "dev": true }, "node_modules/safe-array-concat": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.0.1.tgz", - "integrity": "sha512-6XbUAseYE2KtOuGueyeobCySj9L4+66Tn6KQMOPQJrAJEowYKW/YR/MGJZl7FdydUdaFu4LYyDZjxf4/Nmo23Q==", + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.1", + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", "has-symbols": "^1.0.3", "isarray": "^2.0.5" }, @@ -13672,15 +11355,18 @@ "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" }, "node_modules/safe-regex-test": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.0.tgz", - "integrity": "sha512-JBUUzyOgEwXQY1NuPtvcj/qcBDbDmEvWufhlnXZIm75DEHp+afM1r1ujJpJsV/gSM4t59tpDyPi1sd6ZaPFfsA==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.3", + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", "is-regex": "^1.1.4" }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -13701,9 +11387,9 @@ } }, "node_modules/semver": { - "version": "7.6.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", - "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", "dev": true, "bin": { "semver": "bin/semver.js" @@ -13712,27 +11398,6 @@ "node": ">=10" } }, - "node_modules/semver-diff": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", - "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", - "dev": true, - "dependencies": { - "semver": "^7.3.5" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/semver-utils": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/semver-utils/-/semver-utils-1.1.4.tgz", - "integrity": "sha512-EjnoLE5OGmDAVV/8YDoN5KiajNadjzIp9BAHOhYeQHt7j0UWxjmgsx4YD48wp4Ue1Qogq38F1GNUJNqF1kKKxA==", - "dev": true - }, "node_modules/send": { "version": "0.16.2", "resolved": "https://registry.npmjs.org/send/-/send-0.16.2.tgz", @@ -13923,28 +11588,31 @@ "dev": true }, "node_modules/set-function-length": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.1.1.tgz", - "integrity": "sha512-VoaqjbBJKiWtg4yRcKBQ7g7wnGnLV3M8oLvVWwOk2PdYY6PEFegR1vezXR0tw6fZGF9csVakIRjrJiy2veSBFQ==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", "dependencies": { - "define-data-property": "^1.1.1", - "get-intrinsic": "^1.2.1", + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.0" + "has-property-descriptors": "^1.0.2" }, "engines": { "node": ">= 0.4" } }, "node_modules/set-function-name": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.1.tgz", - "integrity": "sha512-tMNCiqYVkXIZgc2Hnoy2IvC/f8ezc5koaRFkCjrpWzGpCd3qbZXPzVy9MAZzK1ch/X0jvSkojys3oqJN0qCmdA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", "dev": true, "dependencies": { - "define-data-property": "^1.0.1", + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", "functions-have-names": "^1.2.3", - "has-property-descriptors": "^1.0.0" + "has-property-descriptors": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -14056,25 +11724,6 @@ "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", "dev": true }, - "node_modules/sigstore": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/sigstore/-/sigstore-1.9.0.tgz", - "integrity": "sha512-0Zjz0oe37d08VeOtBIuB6cRriqXse2e8w+7yIy2XSXjshRKxbc2KkhXjL229jXSxEm7UbcjS76wcJDGQddVI9A==", - "dev": true, - "dependencies": { - "@sigstore/bundle": "^1.1.0", - "@sigstore/protobuf-specs": "^0.2.0", - "@sigstore/sign": "^1.0.0", - "@sigstore/tuf": "^1.0.3", - "make-fetch-happen": "^11.0.1" - }, - "bin": { - "sigstore": "bin/sigstore.js" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/simple-websocket": { "version": "9.1.0", "resolved": "https://registry.npmjs.org/simple-websocket/-/simple-websocket-9.1.0.tgz", @@ -14153,16 +11802,6 @@ "node": ">=8.0.0" } }, - "node_modules/smart-buffer": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", - "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==", - "dev": true, - "engines": { - "node": ">= 6.0.0", - "npm": ">= 3.0.0" - } - }, "node_modules/socket.io": { "version": "4.7.2", "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-4.7.2.tgz", @@ -14239,34 +11878,6 @@ "node": ">=10.0.0" } }, - "node_modules/socks": { - "version": "2.8.3", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.8.3.tgz", - "integrity": "sha512-l5x7VUUWbjVFbafGLxPWkYsHIhEvmF85tbIeFZWc8ZPtoMyybuEhL7Jye/ooC4/d48FgOjSJXgsF/AJPYCW8Zw==", - "dev": true, - "dependencies": { - "ip-address": "^9.0.5", - "smart-buffer": "^4.2.0" - }, - "engines": { - "node": ">= 10.0.0", - "npm": ">= 3.0.0" - } - }, - "node_modules/socks-proxy-agent": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-7.0.0.tgz", - "integrity": "sha512-Fgl0YPZ902wEsAyiQ+idGd1A7rSFx/ayC1CQVMw5P+EQx2V0SgpGtf6OKFhVjPflPUl9YMmEOnmfjCdMUsygww==", - "dev": true, - "dependencies": { - "agent-base": "^6.0.2", - "debug": "^4.3.3", - "socks": "^2.6.2" - }, - "engines": { - "node": ">= 10" - } - }, "node_modules/source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -14295,18 +11906,6 @@ "source-map": "^0.6.0" } }, - "node_modules/spawn-please": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/spawn-please/-/spawn-please-2.0.2.tgz", - "integrity": "sha512-KM8coezO6ISQ89c1BzyWNtcn2V2kAVtwIXd3cN/V5a0xPYc1F/vydrRc01wsKFEQ/p+V1a4sw4z2yMITIXrgGw==", - "dev": true, - "dependencies": { - "cross-spawn": "^7.0.3" - }, - "engines": { - "node": ">=14" - } - }, "node_modules/spdx-correct": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", @@ -14365,27 +11964,6 @@ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" }, - "node_modules/ssri": { - "version": "10.0.5", - "resolved": "https://registry.npmjs.org/ssri/-/ssri-10.0.5.tgz", - "integrity": "sha512-bSf16tAFkGeRlUNDjXu8FzaMQt6g2HZJrun7mtMbIPOddxt3GLMSz5VWUWcqTJUPfLEaDIepGxv+bYQW49596A==", - "dev": true, - "dependencies": { - "minipass": "^7.0.3" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/ssri/node_modules/minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true, - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, "node_modules/stack-utils": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.5.tgz", @@ -14652,52 +12230,22 @@ } }, "node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", "dev": true, "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/string-width-cjs": { - "name": "string-width", - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/string-width-cjs/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/string-width-cjs/node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/string-width/node_modules/ansi-regex": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", @@ -14711,9 +12259,9 @@ } }, "node_modules/string-width/node_modules/strip-ansi": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz", - "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", "dev": true, "dependencies": { "ansi-regex": "^6.0.1" @@ -14726,14 +12274,15 @@ } }, "node_modules/string.prototype.trim": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.8.tgz", - "integrity": "sha512-lfjY4HcixfQXOfaqCvcBuOIapyaroTXhbkfJN3gcB1OtyupngWK4sEET9Knd0cXd28kTUqu/kHoV4HKSJdnjiQ==", + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" }, "engines": { "node": ">= 0.4" @@ -14743,28 +12292,31 @@ } }, "node_modules/string.prototype.trimend": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.7.tgz", - "integrity": "sha512-Ni79DqeB72ZFq1uH/L6zJ+DKZTkOtPIHovb3YZHQViE+HDouuU4mBrLOLDn5Dde3RF8qw5qVETEjhu9locMLvA==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" }, "funding": { "url": "https://github.com/sponsors/ljharb" } }, "node_modules/string.prototype.trimstart": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.7.tgz", - "integrity": "sha512-NGhtDFu3jCEm7B4Fy0DpLewdJQOZcQ0rGbwQ/+stjnrp2i+rlKeCvos9hOIeCmqwratM47OBxY7uFZzjxHXmrg==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -14788,19 +12340,6 @@ "node": ">=8" } }, - "node_modules/strip-ansi-cjs": { - "name": "strip-ansi", - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/strip-bom": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", @@ -15015,9 +12554,9 @@ } }, "node_modules/synckit": { - "version": "0.8.8", - "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.8.8.tgz", - "integrity": "sha512-HwOKAP7Wc5aRGYdKH+dw0PRRpbO841v2DENBtjnR5HFWoiNByAl7vrx3p0G/rCyYXQsrxqtX48TImFtPcIHSpQ==", + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.9.1.tgz", + "integrity": "sha512-7gr8p9TQP6RAHusBOSLs46F4564ZrjV8xFmw5zCmgmhGUcw2hxsShhJ6CEiHQMgPDwAQ1fWHPM0ypc4RMAig4A==", "dev": true, "dependencies": { "@pkgr/core": "^0.1.0", @@ -15039,47 +12578,6 @@ "node": ">=6" } }, - "node_modules/tar": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/tar/-/tar-6.2.1.tgz", - "integrity": "sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==", - "dev": true, - "dependencies": { - "chownr": "^2.0.0", - "fs-minipass": "^2.0.0", - "minipass": "^5.0.0", - "minizlib": "^2.1.1", - "mkdirp": "^1.0.3", - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, - "node_modules/tar/node_modules/fs-minipass": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", - "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", - "dev": true, - "dependencies": { - "minipass": "^3.0.0" - }, - "engines": { - "node": ">= 8" - } - }, - "node_modules/tar/node_modules/fs-minipass/node_modules/minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -15186,12 +12684,12 @@ } }, "node_modules/ts-auto-mock": { - "version": "3.7.3", - "resolved": "https://registry.npmjs.org/ts-auto-mock/-/ts-auto-mock-3.7.3.tgz", - "integrity": "sha512-EmFVlfQQWogVtWWgkDXVdtLgGje0P8PaWFz217A4ojNIMwF+iKFnim6ykZsGAtClWCfmGig0VMH7KlbMxc8yKw==", + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/ts-auto-mock/-/ts-auto-mock-3.7.4.tgz", + "integrity": "sha512-+/X+7yjpUBsIJBRxl/hs9aq3pA76w3Pcu70uHDxdr4C8TbXXwd/gq6t3b81xqU9N/KPFIFata1HcQZ2lwGKDRQ==", "dependencies": { "lodash-es": "4.17.21", - "micromatch": "4.0.5" + "micromatch": "4.0.8" }, "engines": { "node": ">=14.x.x", @@ -15202,19 +12700,20 @@ } }, "node_modules/ts-jest": { - "version": "29.1.4", - "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.1.4.tgz", - "integrity": "sha512-YiHwDhSvCiItoAgsKtoLFCuakDzDsJ1DLDnSouTaTmdOcOwIkSzbLXduaQ6M5DRVhuZC/NYaaZ/mtHbWMv/S6Q==", + "version": "29.2.5", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.2.5.tgz", + "integrity": "sha512-KD8zB2aAZrcKIdGk4OwpJggeLcH1FgrICqDSROWqlnJXGCXK4Mn6FcdK2B6670Xr73lHMG1kHw8R87A0ecZ+vA==", "dev": true, "dependencies": { - "bs-logger": "0.x", - "fast-json-stable-stringify": "2.x", + "bs-logger": "^0.2.6", + "ejs": "^3.1.10", + "fast-json-stable-stringify": "^2.1.0", "jest-util": "^29.0.0", "json5": "^2.2.3", - "lodash.memoize": "4.x", - "make-error": "1.x", - "semver": "^7.5.3", - "yargs-parser": "^21.0.1" + "lodash.memoize": "^4.1.2", + "make-error": "^1.3.6", + "semver": "^7.6.3", + "yargs-parser": "^21.1.1" }, "bin": { "ts-jest": "cli.js" @@ -15249,9 +12748,9 @@ } }, "node_modules/ts-jest/node_modules/yargs-parser": { - "version": "21.0.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.0.1.tgz", - "integrity": "sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==", + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", "dev": true, "engines": { "node": ">=12" @@ -15310,9 +12809,9 @@ } }, "node_modules/ts-patch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/ts-patch/-/ts-patch-3.1.2.tgz", - "integrity": "sha512-n58F5AqjUMdp9RAKq+E1YBkmONltPVbt1nN+wrmZXoYZek6QcvaTuqvKMhYhr5BxtC53kD/exxIPA1cP1RQxsA==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ts-patch/-/ts-patch-3.2.1.tgz", + "integrity": "sha512-hlR43v+GUIUy8/ZGFP1DquEqPh7PFKQdDMTAmYt671kCCA6AkDQMoeFaFmZ7ObPLYOmpMgyKUqL1C+coFMf30w==", "dev": true, "dependencies": { "chalk": "^4.1.2", @@ -15361,25 +12860,11 @@ } }, "node_modules/tslib": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", - "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz", + "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA==", "dev": true }, - "node_modules/tuf-js": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/tuf-js/-/tuf-js-1.1.7.tgz", - "integrity": "sha512-i3P9Kgw3ytjELUfpuKVDNBJvk4u5bXL6gskv572mcevPbSKCV3zt3djhmlEQ65yERjIbOSncy7U4cQJaB1CBCg==", - "dev": true, - "dependencies": { - "@tufjs/models": "1.0.4", - "debug": "^4.3.4", - "make-fetch-happen": "^11.1.1" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", @@ -15414,29 +12899,30 @@ } }, "node_modules/typed-array-buffer": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.0.tgz", - "integrity": "sha512-Y8KTSIglk9OZEr8zywiIHG/kmQ7KWyjseXs1CbSo8vC42w7hg2HgYTxSWwP0+is7bWDc1H+Fo026CpHFwm8tkw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.1", - "is-typed-array": "^1.1.10" + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" }, "engines": { "node": ">= 0.4" } }, "node_modules/typed-array-byte-length": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.0.tgz", - "integrity": "sha512-Or/+kvLxNpeQ9DtSydonMxCx+9ZXOswtwJn17SNLvhptaXYDJvkFFP5zbfU/uLmvnBJlI4yrnXRxpdWH/M5tNA==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", + "call-bind": "^1.0.7", "for-each": "^0.3.3", - "has-proto": "^1.0.1", - "is-typed-array": "^1.1.10" + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" }, "engines": { "node": ">= 0.4" @@ -15446,16 +12932,17 @@ } }, "node_modules/typed-array-byte-offset": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.0.tgz", - "integrity": "sha512-RD97prjEt9EL8YgAgpOkf3O4IF9lhJFr9g0htQkm0rchFp/Vx7LW5Q8fSXXub7BXAODyUQohRMyOc3faCPd0hg==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", "dev": true, "dependencies": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", "for-each": "^0.3.3", - "has-proto": "^1.0.1", - "is-typed-array": "^1.1.10" + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" }, "engines": { "node": ">= 0.4" @@ -15465,14 +12952,20 @@ } }, "node_modules/typed-array-length": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.4.tgz", - "integrity": "sha512-KjZypGq+I/H7HI5HlOoGHkWUUGq+Q0TPhQurLbyrVrvnKTBgzLhIJ7j6J/XTQOi0d1RjyZ0wdas8bKs2p0x3Ng==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", "dev": true, "dependencies": { - "call-bind": "^1.0.2", + "call-bind": "^1.0.7", "for-each": "^0.3.3", - "is-typed-array": "^1.1.9" + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -15484,19 +12977,10 @@ "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", "dev": true }, - "node_modules/typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "dev": true, - "dependencies": { - "is-typedarray": "^1.0.0" - } - }, "node_modules/typescript": { - "version": "5.4.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", - "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==", + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", + "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -15556,17 +13040,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", - "dependencies": { - "@fastify/busboy": "^2.0.0" - }, - "engines": { - "node": ">=14.0" - } - }, "node_modules/unicorn-magic": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.1.0.tgz", @@ -15579,45 +13052,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/unique-filename": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-3.0.0.tgz", - "integrity": "sha512-afXhuC55wkAmZ0P18QsVE6kp8JaxrEokN2HGIoIVv2ijHQd419H0+6EigAFcIzXeMIkcIkNBpB3L/DXB3cTS/g==", - "dev": true, - "dependencies": { - "unique-slug": "^4.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/unique-slug": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/unique-slug/-/unique-slug-4.0.0.tgz", - "integrity": "sha512-WrcA6AyEfqDX5bWige/4NQfPZMtASNVxdmWR76WESYQVAACSgWcR6e9i0mofqqBxYFtL4oAxPIptY73/0YE1DQ==", - "dev": true, - "dependencies": { - "imurmurhash": "^0.1.4" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, - "node_modules/unique-string": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", - "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", - "dev": true, - "dependencies": { - "crypto-random-string": "^4.0.0" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", @@ -15627,15 +13061,6 @@ "node": ">= 0.8" } }, - "node_modules/untildify": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/untildify/-/untildify-4.0.0.tgz", - "integrity": "sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==", - "dev": true, - "engines": { - "node": ">=8" - } - }, "node_modules/update-browserslist-db": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.7.tgz", @@ -15653,53 +13078,13 @@ ], "dependencies": { "escalade": "^3.1.1", - "picocolors": "^1.0.0" - }, - "bin": { - "browserslist-lint": "cli.js" - }, - "peerDependencies": { - "browserslist": ">= 4.21.0" - } - }, - "node_modules/update-notifier": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", - "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", - "dev": true, - "dependencies": { - "boxen": "^7.0.0", - "chalk": "^5.0.1", - "configstore": "^6.0.0", - "has-yarn": "^3.0.0", - "import-lazy": "^4.0.0", - "is-ci": "^3.0.1", - "is-installed-globally": "^0.4.0", - "is-npm": "^6.0.0", - "is-yarn-global": "^0.4.0", - "latest-version": "^7.0.0", - "pupa": "^3.1.0", - "semver": "^7.3.7", - "semver-diff": "^4.0.0", - "xdg-basedir": "^5.1.0" - }, - "engines": { - "node": ">=14.16" + "picocolors": "^1.0.0" }, - "funding": { - "url": "https://github.com/yeoman/update-notifier?sponsor=1" - } - }, - "node_modules/update-notifier/node_modules/chalk": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.0.1.tgz", - "integrity": "sha512-Fo07WOYGqMfCWHOzSXOt2CxDbC6skS/jO9ynEcmpANMoPrD+W1r1K6Vx7iNm+AQmETU1Xr2t+n8nzkV9t6xh3w==", - "dev": true, - "engines": { - "node": "^12.17.0 || ^14.13 || >=16.0.0" + "bin": { + "browserslist-lint": "cli.js" }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" + "peerDependencies": { + "browserslist": ">= 4.21.0" } }, "node_modules/uri-js": { @@ -15769,18 +13154,6 @@ "spdx-expression-parse": "^3.0.0" } }, - "node_modules/validate-npm-package-name": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-5.0.0.tgz", - "integrity": "sha512-YuKoXDAhBYxY7SfOKxHBDoSyENFeW5VvIIQp2TGQuit8gpK6MnWaQelBKxso72DoxTZfZdcP3W90LqpSkgPzLQ==", - "dev": true, - "dependencies": { - "builtins": "^5.0.0" - }, - "engines": { - "node": "^14.17.0 || ^16.13.0 || >=18.0.0" - } - }, "node_modules/vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -15851,16 +13224,16 @@ "dev": true }, "node_modules/which-typed-array": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.13.tgz", - "integrity": "sha512-P5Nra0qjSncduVPEAr7xhoF5guty49ArDTwzJ/yNuPIbZppyRxFQsRCWrocxIY+CnMVG+qfbU2FmDKyvSGClow==", + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", "dev": true, "dependencies": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.4", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", "for-each": "^0.3.3", "gopd": "^1.0.1", - "has-tostringtag": "^1.0.0" + "has-tostringtag": "^1.0.2" }, "engines": { "node": ">= 0.4" @@ -15869,59 +13242,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/wide-align": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.5.tgz", - "integrity": "sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==", - "dev": true, - "dependencies": { - "string-width": "^1.0.2 || 2 || 3 || 4" - } - }, - "node_modules/wide-align/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/wide-align/node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/wide-align/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/widest-line": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", - "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", - "dev": true, - "dependencies": { - "string-width": "^5.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/wordwrap": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz", @@ -15945,53 +13265,6 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, - "node_modules/wrap-ansi-cjs": { - "name": "wrap-ansi", - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/wrap-ansi-cjs/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "node_modules/wrap-ansi-cjs/node_modules/is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/wrap-ansi-cjs/node_modules/string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/wrap-ansi/node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", @@ -16061,18 +13334,6 @@ } } }, - "node_modules/xdg-basedir": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", - "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/xml": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/xml/-/xml-1.0.1.tgz", @@ -16113,9 +13374,9 @@ "dev": true }, "node_modules/yaml": { - "version": "2.4.3", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.3.tgz", - "integrity": "sha512-sntgmxj8o7DE7g/Qi60cqpLBA3HG3STcDA0kO+WfB05jEKhZMbY7umNm2rBpQvsmZ16/lPXCJGW2672dgOUkrg==", + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.1.tgz", + "integrity": "sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q==", "dev": true, "bin": { "yaml": "bin.mjs" @@ -16464,7 +13725,6 @@ "version": "7.22.13", "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.22.13.tgz", "integrity": "sha512-XktuhWlJ5g+3TJXc5upd9Ks1HutSArik6jf2eAjYFyIOf4ej3RN+184cZbzDvbPnuTJIUhPKKJE3cIsYTiAT3w==", - "dev": true, "requires": { "@babel/highlight": "^7.22.13", "chalk": "^2.4.2" @@ -16474,7 +13734,6 @@ "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, "requires": { "color-convert": "^1.9.0" } @@ -16483,7 +13742,6 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, "requires": { "ansi-styles": "^3.2.1", "escape-string-regexp": "^1.0.5", @@ -16494,7 +13752,6 @@ "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, "requires": { "color-name": "1.1.3" } @@ -16502,26 +13759,22 @@ "color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", - "dev": true + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==" }, "escape-string-regexp": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", - "dev": true + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==" }, "has-flag": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", - "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", - "dev": true + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==" }, "supports-color": { "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, "requires": { "has-flag": "^3.0.0" } @@ -16693,8 +13946,7 @@ "@babel/helper-validator-identifier": { "version": "7.22.20", "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.22.20.tgz", - "integrity": "sha512-Y4OZ+ytlatR8AI+8KZfKuL5urKp7qey08ha31L8b3BwewJAoJamTzyvxPR/5D+KkdJCGPq/+8TukHBlY10FX9A==", - "dev": true + "integrity": "sha512-Y4OZ+ytlatR8AI+8KZfKuL5urKp7qey08ha31L8b3BwewJAoJamTzyvxPR/5D+KkdJCGPq/+8TukHBlY10FX9A==" }, "@babel/helper-validator-option": { "version": "7.18.6", @@ -16717,7 +13969,6 @@ "version": "7.22.20", "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.22.20.tgz", "integrity": "sha512-dkdMCN3py0+ksCgYmGG8jKeGA/8Tk+gJwSYYlFGxG5lmhfKNoAy004YpLxpS1W2J8m/EK2Ew+yOs9pVRwO89mg==", - "dev": true, "requires": { "@babel/helper-validator-identifier": "^7.22.20", "chalk": "^2.4.2", @@ -16728,7 +13979,6 @@ "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", - "dev": true, "requires": { "color-convert": "^1.9.0" } @@ -16737,7 +13987,6 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", - "dev": true, "requires": { "ansi-styles": "^3.2.1", "escape-string-regexp": "^1.0.5", @@ -16748,7 +13997,6 @@ "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", - "dev": true, "requires": { "color-name": "1.1.3" } @@ -16756,26 +14004,22 @@ "color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", - "dev": true + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==" }, "escape-string-regexp": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", - "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", - "dev": true + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==" }, "has-flag": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", - "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", - "dev": true + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==" }, "supports-color": { "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, "requires": { "has-flag": "^3.0.0" } @@ -16977,23 +14221,16 @@ "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", "dev": true }, - "@colors/colors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@colors/colors/-/colors-1.5.0.tgz", - "integrity": "sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==", - "dev": true, - "optional": true - }, "@commitlint/cli": { - "version": "19.3.0", - "resolved": "https://registry.npmjs.org/@commitlint/cli/-/cli-19.3.0.tgz", - "integrity": "sha512-LgYWOwuDR7BSTQ9OLZ12m7F/qhNY+NpAyPBgo4YNMkACE7lGuUnuQq1yi9hz1KA4+3VqpOYl8H1rY/LYK43v7g==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/cli/-/cli-19.4.1.tgz", + "integrity": "sha512-EerFVII3ZcnhXsDT9VePyIdCJoh3jEzygN1L37MjQXgPfGS6fJTWL/KHClVMod1d8w94lFC3l4Vh/y5ysVAz2A==", "dev": true, "requires": { "@commitlint/format": "^19.3.0", - "@commitlint/lint": "^19.2.2", - "@commitlint/load": "^19.2.0", - "@commitlint/read": "^19.2.1", + "@commitlint/lint": "^19.4.1", + "@commitlint/load": "^19.4.0", + "@commitlint/read": "^19.4.0", "@commitlint/types": "^19.0.3", "execa": "^8.0.1", "yargs": "^17.0.0" @@ -17079,9 +14316,9 @@ } }, "@commitlint/config-conventional": { - "version": "19.2.2", - "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.2.2.tgz", - "integrity": "sha512-mLXjsxUVLYEGgzbxbxicGPggDuyWNkf25Ht23owXIH+zV2pv1eJuzLK3t1gDY5Gp6pxdE60jZnWUY5cvgL3ufw==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/config-conventional/-/config-conventional-19.4.1.tgz", + "integrity": "sha512-D5S5T7ilI5roybWGc8X35OBlRXLAwuTseH1ro0XgqkOWrhZU8yOwBOslrNmSDlTXhXLq8cnfhQyC42qaUCzlXA==", "dev": true, "requires": { "@commitlint/types": "^19.0.3", @@ -17158,21 +14395,21 @@ } }, "@commitlint/lint": { - "version": "19.2.2", - "resolved": "https://registry.npmjs.org/@commitlint/lint/-/lint-19.2.2.tgz", - "integrity": "sha512-xrzMmz4JqwGyKQKTpFzlN0dx0TAiT7Ran1fqEBgEmEj+PU98crOFtysJgY+QdeSagx6EDRigQIXJVnfrI0ratA==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/lint/-/lint-19.4.1.tgz", + "integrity": "sha512-Ws4YVAZ0jACTv6VThumITC1I5AG0UyXMGua3qcf55JmXIXm/ejfaVKykrqx7RyZOACKVAs8uDRIsEsi87JZ3+Q==", "dev": true, "requires": { "@commitlint/is-ignored": "^19.2.2", "@commitlint/parse": "^19.0.3", - "@commitlint/rules": "^19.0.3", + "@commitlint/rules": "^19.4.1", "@commitlint/types": "^19.0.3" } }, "@commitlint/load": { - "version": "19.2.0", - "resolved": "https://registry.npmjs.org/@commitlint/load/-/load-19.2.0.tgz", - "integrity": "sha512-XvxxLJTKqZojCxaBQ7u92qQLFMMZc4+p9qrIq/9kJDy8DOrEa7P1yx7Tjdc2u2JxIalqT4KOGraVgCE7eCYJyQ==", + "version": "19.4.0", + "resolved": "https://registry.npmjs.org/@commitlint/load/-/load-19.4.0.tgz", + "integrity": "sha512-I4lCWaEZYQJ1y+Y+gdvbGAx9pYPavqZAZ3/7/8BpWh+QjscAn8AjsUpLV2PycBsEx7gupq5gM4BViV9xwTIJuw==", "dev": true, "requires": { "@commitlint/config-validator": "^19.0.3", @@ -17263,9 +14500,9 @@ } }, "@commitlint/read": { - "version": "19.2.1", - "resolved": "https://registry.npmjs.org/@commitlint/read/-/read-19.2.1.tgz", - "integrity": "sha512-qETc4+PL0EUv7Q36lJbPG+NJiBOGg7SSC7B5BsPWOmei+Dyif80ErfWQ0qXoW9oCh7GTpTNRoaVhiI8RbhuaNw==", + "version": "19.4.0", + "resolved": "https://registry.npmjs.org/@commitlint/read/-/read-19.4.0.tgz", + "integrity": "sha512-r95jLOEZzKDakXtnQub+zR3xjdnrl2XzerPwm7ch1/cc5JGq04tyaNpa6ty0CRCWdVrk4CZHhqHozb8yZwy2+g==", "dev": true, "requires": { "@commitlint/top-level": "^19.0.0", @@ -17398,9 +14635,9 @@ } }, "@commitlint/rules": { - "version": "19.0.3", - "resolved": "https://registry.npmjs.org/@commitlint/rules/-/rules-19.0.3.tgz", - "integrity": "sha512-TspKb9VB6svklxNCKKwxhELn7qhtY1rFF8ls58DcFd0F97XoG07xugPjjbVnLqmMkRjZDbDIwBKt9bddOfLaPw==", + "version": "19.4.1", + "resolved": "https://registry.npmjs.org/@commitlint/rules/-/rules-19.4.1.tgz", + "integrity": "sha512-AgctfzAONoVxmxOXRyxXIq7xEPrd7lK/60h2egp9bgGUMZK9v0+YqLOA+TH+KqCa63ZoCr8owP2YxoSSu7IgnQ==", "dev": true, "requires": { "@commitlint/ensure": "^19.0.3", @@ -17549,9 +14786,9 @@ "dev": true }, "yocto-queue": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.0.0.tgz", - "integrity": "sha512-9bnSc/HEW2uRy67wc+T8UwauLuPJVn28jb+GtJY16iiKWyvmYJRXVT4UamsAEGQfPohgr2q4Tq0sQbQlxTfi1g==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-1.1.1.tgz", + "integrity": "sha512-b4JR1PFR10y1mKjhHY9LaGo6tmrgjit7hxVIeAmyMw3jegXR4dhYqLaQF5zMXZxY7tLpMyJeLjr1C4rLmkVe8g==", "dev": true } } @@ -17680,11 +14917,6 @@ "integrity": "sha512-5Aap/GaRupgNx/feGBwLLTVv8OQFfv3pq2lPRzPg9R+IOBnDgghTGW7l7EuVXOvg5cc/xSAlRW8rBrjIC3Nvqw==", "dev": true }, - "@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==" - }, "@humanwhocodes/config-array": { "version": "0.11.14", "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.11.14.tgz", @@ -17714,54 +14946,6 @@ "integrity": "sha512-H9XAx3hc0BQHY6l+IFSWHDySypcXsvsuLhgYLUGywmJ5pswRVQJUHpOsobnLYp2ZUaUlKiKDrgWWhosOwAEM8Q==", "dev": true }, - "@isaacs/cliui": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", - "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, - "requires": { - "string-width": "^5.1.2", - "string-width-cjs": "npm:string-width@^4.2.0", - "strip-ansi": "^7.0.1", - "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", - "wrap-ansi": "^8.1.0", - "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" - }, - "dependencies": { - "ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true - }, - "ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true - }, - "strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "requires": { - "ansi-regex": "^6.0.1" - } - }, - "wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, - "requires": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - } - } - } - }, "@istanbuljs/load-nyc-config": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", @@ -18129,6 +15313,7 @@ "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, "requires": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -18137,150 +15322,30 @@ "@nodelib/fs.stat": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==" + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true }, "@nodelib/fs.walk": { "version": "1.2.8", "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, "requires": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, - "@npmcli/fs": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@npmcli/fs/-/fs-3.1.0.tgz", - "integrity": "sha512-7kZUAaLscfgbwBQRbvdMYaZOWyMEcPTH/tJjnyAWJ/dvvs9Ef+CERx/qJb9GExJpl1qipaDGn7KqHnFGGixd0w==", - "dev": true, - "requires": { - "semver": "^7.3.5" - } - }, - "@npmcli/git": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/@npmcli/git/-/git-4.1.0.tgz", - "integrity": "sha512-9hwoB3gStVfa0N31ymBmrX+GuDGdVA/QWShZVqE0HK2Af+7QGGrCTbZia/SW0ImUTjTne7SP91qxDmtXvDHRPQ==", - "dev": true, - "requires": { - "@npmcli/promise-spawn": "^6.0.0", - "lru-cache": "^7.4.4", - "npm-pick-manifest": "^8.0.0", - "proc-log": "^3.0.0", - "promise-inflight": "^1.0.1", - "promise-retry": "^2.0.1", - "semver": "^7.3.5", - "which": "^3.0.0" - }, - "dependencies": { - "lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true - }, - "which": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", - "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "@npmcli/installed-package-contents": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@npmcli/installed-package-contents/-/installed-package-contents-2.0.2.tgz", - "integrity": "sha512-xACzLPhnfD51GKvTOOuNX2/V4G4mz9/1I2MfDoye9kBM3RYe5g2YbscsaGoTlaWqkxeiapBWyseULVKpSVHtKQ==", - "dev": true, - "requires": { - "npm-bundled": "^3.0.0", - "npm-normalize-package-bin": "^3.0.0" - } - }, - "@npmcli/node-gyp": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@npmcli/node-gyp/-/node-gyp-3.0.0.tgz", - "integrity": "sha512-gp8pRXC2oOxu0DUE1/M3bYtb1b3/DbJ5aM113+XJBgfXdussRAsX0YOrOhdd8WvnAR6auDBvJomGAkLKA5ydxA==", + "@nolyfill/is-core-module": { + "version": "1.0.39", + "resolved": "https://registry.npmjs.org/@nolyfill/is-core-module/-/is-core-module-1.0.39.tgz", + "integrity": "sha512-nn5ozdjYQpUCZlWGuxcJY/KpxkWQs4DcbMCmKojjyrYDEAGy4Ce19NN4v5MduafTwJlbKc99UA8YhSVqq9yPZA==", "dev": true }, - "@npmcli/promise-spawn": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/@npmcli/promise-spawn/-/promise-spawn-6.0.2.tgz", - "integrity": "sha512-gGq0NJkIGSwdbUt4yhdF8ZrmkGKVz9vAdVzpOfnom+V8PLSmSOVhZwbNvZZS1EYcJN5hzzKBxmmVVAInM6HQLg==", - "dev": true, - "requires": { - "which": "^3.0.0" - }, - "dependencies": { - "which": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", - "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "@npmcli/run-script": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/@npmcli/run-script/-/run-script-6.0.2.tgz", - "integrity": "sha512-NCcr1uQo1k5U+SYlnIrbAh3cxy+OQT1VtqiAbxdymSlptbzBb62AjH2xXgjNCoP073hoa1CfCAcwoZ8k96C4nA==", - "dev": true, - "requires": { - "@npmcli/node-gyp": "^3.0.0", - "@npmcli/promise-spawn": "^6.0.0", - "node-gyp": "^9.0.0", - "read-package-json-fast": "^3.0.0", - "which": "^3.0.0" - }, - "dependencies": { - "which": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-3.0.1.tgz", - "integrity": "sha512-XA1b62dzQzLfaEOSQFTCOd5KFf/1VSzZo7/7TUjnya6u0vGGKzU96UQBZTAThCb2j4/xjBAyii1OhRLJEivHvg==", - "dev": true, - "requires": { - "isexe": "^2.0.0" - } - } - } - }, - "@pkgjs/parseargs": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", - "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "dev": true, - "optional": true - }, "@pkgr/core": { "version": "0.1.1", - "resolved": "https://registry.npmjs.org/@pkgr/core/-/core-0.1.1.tgz", - "integrity": "sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA==", - "dev": true - }, - "@pnpm/network.ca-file": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.1.tgz", - "integrity": "sha512-gkINruT2KUhZLTaiHxwCOh1O4NVnFT0wLjWFBHmTz9vpKag/C/noIMJXBxFe4F0mYpUVX2puLwAieLYFg2NvoA==", - "dev": true, - "requires": { - "graceful-fs": "4.2.10" - } - }, - "@pnpm/npm-conf": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-1.0.4.tgz", - "integrity": "sha512-o5YFq/+ksEJMbSzzkaQDHlp00aonLDU5xNPVTRL12hTWBbVSSeWXxPukq75h+mvXnoOWT95vV2u1HSTw2C4XOw==", - "dev": true, - "requires": { - "@pnpm/network.ca-file": "^1.0.1", - "config-chain": "^1.1.11" - } + "resolved": "https://registry.npmjs.org/@pkgr/core/-/core-0.1.1.tgz", + "integrity": "sha512-cq8o4cWH0ibXh9VGi5P20Tu9XF/0fFXl9EUinr9QfTM7a7p0oTA4iJRCQWppXR1Pg8dSM0UCItCkPwsk9qWWYA==", + "dev": true }, "@redocly/ajv": { "version": "8.11.0", @@ -18357,6 +15422,11 @@ } } }, + "@redocly/config": { + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.10.1.tgz", + "integrity": "sha512-H3LnKVGzOaxskwJu8pmJYwBOWjP61qOK7TuTrbafqArDVckE06fhA6l0nO4KvBbjLPjy1Al7UnlxOu23V4Nl0w==" + }, "@redocly/openapi-cli": { "version": "1.0.0-beta.95", "resolved": "https://registry.npmjs.org/@redocly/openapi-cli/-/openapi-cli-1.0.0-beta.95.tgz", @@ -18480,54 +15550,18 @@ } } }, - "@sigstore/bundle": { + "@rtsao/scc": { "version": "1.1.0", - "resolved": "https://registry.npmjs.org/@sigstore/bundle/-/bundle-1.1.0.tgz", - "integrity": "sha512-PFutXEy0SmQxYI4texPw3dd2KewuNqv7OuK1ZFtY2fM754yhvG2KdgwIhRnoEE2uHdtdGNQ8s0lb94dW9sELog==", - "dev": true, - "requires": { - "@sigstore/protobuf-specs": "^0.2.0" - } - }, - "@sigstore/protobuf-specs": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/@sigstore/protobuf-specs/-/protobuf-specs-0.2.0.tgz", - "integrity": "sha512-8ZhZKAVfXjIspDWwm3D3Kvj0ddbJ0HqDZ/pOs5cx88HpT8mVsotFrg7H1UMnXOuDHz6Zykwxn4mxG3QLuN+RUg==", + "resolved": "https://registry.npmjs.org/@rtsao/scc/-/scc-1.1.0.tgz", + "integrity": "sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==", "dev": true }, - "@sigstore/sign": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@sigstore/sign/-/sign-1.0.0.tgz", - "integrity": "sha512-INxFVNQteLtcfGmcoldzV6Je0sbbfh9I16DM4yJPw3j5+TFP8X6uIiA18mvpEa9yyeycAKgPmOA3X9hVdVTPUA==", - "dev": true, - "requires": { - "@sigstore/bundle": "^1.1.0", - "@sigstore/protobuf-specs": "^0.2.0", - "make-fetch-happen": "^11.0.1" - } - }, - "@sigstore/tuf": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@sigstore/tuf/-/tuf-1.0.3.tgz", - "integrity": "sha512-2bRovzs0nJZFlCN3rXirE4gwxCn97JNjMmwpecqlbgV9WcxX7WRuIrgzx/X7Ib7MYRbyUTpBYE0s2x6AmZXnlg==", - "dev": true, - "requires": { - "@sigstore/protobuf-specs": "^0.2.0", - "tuf-js": "^1.1.7" - } - }, "@sinclair/typebox": { "version": "0.27.8", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.27.8.tgz", "integrity": "sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==", "dev": true }, - "@sindresorhus/is": { - "version": "4.6.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-4.6.0.tgz", - "integrity": "sha512-t09vSN3MdfsyCHoFcTRCH/iUtG7OJ0CsjzB8cjAmKc/va/kIgeDI/TxsigdncE/4be734m0cvIYwNaV4i2XqAw==", - "dev": true - }, "@sinonjs/commons": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-3.0.0.tgz", @@ -18552,21 +15586,6 @@ "integrity": "sha512-+9jVqKhRSpsc591z5vX+X5Yyw+he/HCB4iQ/RYxw35CEPaY1gnsNE43nf9n9AaYjAQrTiI/mOwKUKdUs9vf7Xg==", "dev": true }, - "@szmarczak/http-timer": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-5.0.1.tgz", - "integrity": "sha512-+PmQX0PiAYPMeVYe237LJAYvOMYW1j2rH5YROyS3b4CTVJum34HfRvKvAzozHAQG0TnHNdUfY9nCeUyRAs//cw==", - "dev": true, - "requires": { - "defer-to-connect": "^2.0.1" - } - }, - "@tootallnate/once": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-2.0.0.tgz", - "integrity": "sha512-XCuKFP5PS55gnMVu3dty8KPatLqUoy/ZYzDzAGCQ8JNFCkLXzmI7vNHCR+XpbZaMWQK/vQubr7PkYq8g470J/A==", - "dev": true - }, "@tsconfig/node10": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.8.tgz", @@ -18591,42 +15610,6 @@ "integrity": "sha512-eZxlbI8GZscaGS7kkc/trHTT5xgrjH3/1n2JDwusC9iahPKWMRvRjJSAN5mCXviuTGQ/lHnhvv8Q1YTpnfz9gA==", "dev": true }, - "@tufjs/canonical-json": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@tufjs/canonical-json/-/canonical-json-1.0.0.tgz", - "integrity": "sha512-QTnf++uxunWvG2z3UFNzAoQPHxnSXOwtaI3iJ+AohhV+5vONuArPjJE7aPXPVXfXJsqrVbZBu9b81AJoSd09IQ==", - "dev": true - }, - "@tufjs/models": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/@tufjs/models/-/models-1.0.4.tgz", - "integrity": "sha512-qaGV9ltJP0EO25YfFUPhxRVK0evXFIAGicsVXuRim4Ed9cjPxYhNnNJ49SFmbeLgtxpslIkX317IgpfcHPVj/A==", - "dev": true, - "requires": { - "@tufjs/canonical-json": "1.0.0", - "minimatch": "^9.0.0" - }, - "dependencies": { - "brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "requires": { - "balanced-match": "^1.0.0" - } - }, - "minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "requires": { - "brace-expansion": "^2.0.1" - } - } - } - }, "@types/babel__core": { "version": "7.20.1", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.1.tgz", @@ -18668,18 +15651,6 @@ "@babel/types": "^7.20.7" } }, - "@types/cacheable-request": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/@types/cacheable-request/-/cacheable-request-6.0.2.tgz", - "integrity": "sha512-B3xVo+dlKM6nnKTcmm5ZtY/OL8bOAOd2Olee9M1zft65ox50OzjEHW91sDiU9j6cvW8Ejg1/Qkf4xd2kugApUA==", - "dev": true, - "requires": { - "@types/http-cache-semantics": "*", - "@types/keyv": "*", - "@types/node": "*", - "@types/responselike": "^1.0.0" - } - }, "@types/conventional-commits-parser": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/@types/conventional-commits-parser/-/conventional-commits-parser-5.0.0.tgz", @@ -18723,12 +15694,6 @@ "@types/node": "*" } }, - "@types/http-cache-semantics": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.1.tgz", - "integrity": "sha512-SZs7ekbP8CN0txVG2xVRH6EgKmEm31BOxA07vkFaETzZz1xh+cbt8BcI0slpymvwhx5dlFnQG2rTlPVQn+iRPQ==", - "dev": true - }, "@types/istanbul-lib-coverage": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.4.tgz", @@ -18769,12 +15734,6 @@ "integrity": "sha512-k4MGaQl5TGo/iipqb2UDG2UwjXziSWkh0uysQelTlJpX1qGlpUZYm8PnO4DxG1qBomtJUdYJ6qR6xdIah10JLg==", "dev": true }, - "@types/json-buffer": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/@types/json-buffer/-/json-buffer-3.0.0.tgz", - "integrity": "sha512-3YP80IxxFJB4b5tYC2SUPwkg0XQLiu0nWvhRgEatgjf+29IcWO9X1k8xRv5DGssJ/lCrjYTjQPcobJr2yWIVuQ==", - "dev": true - }, "@types/json-schema": { "version": "7.0.12", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.12.tgz", @@ -18786,15 +15745,6 @@ "integrity": "sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==", "dev": true }, - "@types/keyv": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@types/keyv/-/keyv-3.1.4.tgz", - "integrity": "sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==", - "dev": true, - "requires": { - "@types/node": "*" - } - }, "@types/minimatch": { "version": "3.0.5", "resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-3.0.5.tgz", @@ -18819,21 +15769,6 @@ "integrity": "sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw==", "dev": true }, - "@types/responselike": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/@types/responselike/-/responselike-1.0.0.tgz", - "integrity": "sha512-85Y2BjiufFzaMIlvJDvTTB8Fxl2xfLo4HgmHzVBz08w4wDePCTjYw66PdrolO0kzli3yam/YCgRufyo1DdQVTA==", - "dev": true, - "requires": { - "@types/node": "*" - } - }, - "@types/semver-utils": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@types/semver-utils/-/semver-utils-1.1.3.tgz", - "integrity": "sha512-T+YwkslhsM+CeuhYUxyAjWm7mJ5am/K10UX40RuA6k6Lc7eGtq8iY2xOzy7Vq0GOqhl/xZl5l2FwURZMTPTUww==", - "dev": true - }, "@types/stack-utils": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.1.tgz", @@ -18862,16 +15797,16 @@ "dev": true }, "@typescript-eslint/eslint-plugin": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.11.0.tgz", - "integrity": "sha512-P+qEahbgeHW4JQ/87FuItjBj8O3MYv5gELDzr8QaQ7fsll1gSMTYb6j87MYyxwf3DtD7uGFB9ShwgmCJB5KmaQ==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-8.4.0.tgz", + "integrity": "sha512-rg8LGdv7ri3oAlenMACk9e+AR4wUV0yrrG+XKsGKOK0EVgeEDqurkXMPILG2836fW4ibokTB5v4b6Z9+GYQDEw==", "dev": true, "requires": { "@eslint-community/regexpp": "^4.10.0", - "@typescript-eslint/scope-manager": "7.11.0", - "@typescript-eslint/type-utils": "7.11.0", - "@typescript-eslint/utils": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0", + "@typescript-eslint/scope-manager": "8.4.0", + "@typescript-eslint/type-utils": "8.4.0", + "@typescript-eslint/utils": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0", "graphemer": "^1.4.0", "ignore": "^5.3.1", "natural-compare": "^1.4.0", @@ -18879,56 +15814,56 @@ } }, "@typescript-eslint/parser": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-7.11.0.tgz", - "integrity": "sha512-yimw99teuaXVWsBcPO1Ais02kwJ1jmNA1KxE7ng0aT7ndr1pT1wqj0OJnsYVGKKlc4QJai86l/025L6z8CljOg==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-8.4.0.tgz", + "integrity": "sha512-NHgWmKSgJk5K9N16GIhQ4jSobBoJwrmURaLErad0qlLjrpP5bECYg+wxVTGlGZmJbU03jj/dfnb6V9bw+5icsA==", "dev": true, "requires": { - "@typescript-eslint/scope-manager": "7.11.0", - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/typescript-estree": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0", + "@typescript-eslint/scope-manager": "8.4.0", + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/typescript-estree": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0", "debug": "^4.3.4" } }, "@typescript-eslint/scope-manager": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-7.11.0.tgz", - "integrity": "sha512-27tGdVEiutD4POirLZX4YzT180vevUURJl4wJGmm6TrQoiYwuxTIY98PBp6L2oN+JQxzE0URvYlzJaBHIekXAw==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-8.4.0.tgz", + "integrity": "sha512-n2jFxLeY0JmKfUqy3P70rs6vdoPjHK8P/w+zJcV3fk0b0BwRXC/zxRTEnAsgYT7MwdQDt/ZEbtdzdVC+hcpF0A==", "dev": true, "requires": { - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0" + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0" } }, "@typescript-eslint/type-utils": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-7.11.0.tgz", - "integrity": "sha512-WmppUEgYy+y1NTseNMJ6mCFxt03/7jTOy08bcg7bxJJdsM4nuhnchyBbE8vryveaJUf62noH7LodPSo5Z0WUCg==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-8.4.0.tgz", + "integrity": "sha512-pu2PAmNrl9KX6TtirVOrbLPLwDmASpZhK/XU7WvoKoCUkdtq9zF7qQ7gna0GBZFN0hci0vHaSusiL2WpsQk37A==", "dev": true, "requires": { - "@typescript-eslint/typescript-estree": "7.11.0", - "@typescript-eslint/utils": "7.11.0", + "@typescript-eslint/typescript-estree": "8.4.0", + "@typescript-eslint/utils": "8.4.0", "debug": "^4.3.4", "ts-api-utils": "^1.3.0" } }, "@typescript-eslint/types": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.11.0.tgz", - "integrity": "sha512-MPEsDRZTyCiXkD4vd3zywDCifi7tatc4K37KqTprCvaXptP7Xlpdw0NR2hRJTetG5TxbWDB79Ys4kLmHliEo/w==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.4.0.tgz", + "integrity": "sha512-T1RB3KQdskh9t3v/qv7niK6P8yvn7ja1mS7QK7XfRVL6wtZ8/mFs/FHf4fKvTA0rKnqnYxl/uHFNbnEt0phgbw==", "dev": true }, "@typescript-eslint/typescript-estree": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.11.0.tgz", - "integrity": "sha512-cxkhZ2C/iyi3/6U9EPc5y+a6csqHItndvN/CzbNXTNrsC3/ASoYQZEt9uMaEp+xFNjasqQyszp5TumAVKKvJeQ==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.4.0.tgz", + "integrity": "sha512-kJ2OIP4dQw5gdI4uXsaxUZHRwWAGpREJ9Zq6D5L0BweyOrWsL6Sz0YcAZGWhvKnH7fm1J5YFE1JrQL0c9dd53A==", "dev": true, "requires": { - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/visitor-keys": "7.11.0", + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/visitor-keys": "8.4.0", "debug": "^4.3.4", - "globby": "^11.1.0", + "fast-glob": "^3.3.2", "is-glob": "^4.0.3", "minimatch": "^9.0.4", "semver": "^7.6.0", @@ -18945,9 +15880,9 @@ } }, "minimatch": { - "version": "9.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz", - "integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==", + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", + "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", "dev": true, "requires": { "brace-expansion": "^2.0.1" @@ -18956,24 +15891,24 @@ } }, "@typescript-eslint/utils": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-7.11.0.tgz", - "integrity": "sha512-xlAWwPleNRHwF37AhrZurOxA1wyXowW4PqVXZVUNCLjB48CqdPJoJWkrpH2nij9Q3Lb7rtWindtoXwxjxlKKCA==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-8.4.0.tgz", + "integrity": "sha512-swULW8n1IKLjRAgciCkTCafyTHHfwVQFt8DovmaF69sKbOxTSFMmIZaSHjqO9i/RV0wIblaawhzvtva8Nmm7lQ==", "dev": true, "requires": { "@eslint-community/eslint-utils": "^4.4.0", - "@typescript-eslint/scope-manager": "7.11.0", - "@typescript-eslint/types": "7.11.0", - "@typescript-eslint/typescript-estree": "7.11.0" + "@typescript-eslint/scope-manager": "8.4.0", + "@typescript-eslint/types": "8.4.0", + "@typescript-eslint/typescript-estree": "8.4.0" } }, "@typescript-eslint/visitor-keys": { - "version": "7.11.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.11.0.tgz", - "integrity": "sha512-7syYk4MzjxTEk0g/w3iqtgxnFQspDJfn6QKD36xMuuhTzjcxY7F8EmBLnALjVyaOF1/bVocu3bS/2/F7rXrveQ==", + "version": "8.4.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.4.0.tgz", + "integrity": "sha512-zTQD6WLNTre1hj5wp09nBIDiOc2U5r/qmzo7wxPn4ZgAjHql09EofqhF9WF+fZHzL5aCyaIpPcT2hyxl73kr9A==", "dev": true, "requires": { - "@typescript-eslint/types": "7.11.0", + "@typescript-eslint/types": "8.4.0", "eslint-visitor-keys": "^3.4.3" } }, @@ -18983,12 +15918,6 @@ "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", "dev": true }, - "abbrev": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", - "integrity": "sha512-nne9/IiQ/hzIhY6pdDnbBtz7DjPTKrY00P/zvPSm5pOFkl6xuGrGnXn/VtTNNfNtAfZ9/1RtehkszU9qcTii0Q==", - "dev": true - }, "accepts": { "version": "1.3.8", "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", @@ -19025,31 +15954,11 @@ "dev": true }, "agent-base": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz", - "integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==", - "dev": true, - "requires": { - "debug": "4" - } - }, - "agentkeepalive": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/agentkeepalive/-/agentkeepalive-4.5.0.tgz", - "integrity": "sha512-5GG/5IbQQpC9FpkRGsSvZI5QYeSCzlJHdpBQntCsuTOxhKD8lqKhrleg2Yi7yvMIf82Ycmmqln9U8V9qwEiJew==", - "dev": true, - "requires": { - "humanize-ms": "^1.2.1" - } - }, - "aggregate-error": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/aggregate-error/-/aggregate-error-3.1.0.tgz", - "integrity": "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==", - "dev": true, + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz", + "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==", "requires": { - "clean-stack": "^2.0.0", - "indent-string": "^4.0.0" + "debug": "^4.3.4" } }, "ajv": { @@ -19064,40 +15973,6 @@ "uri-js": "^4.2.2" } }, - "ansi-align": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", - "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", - "dev": true, - "requires": { - "string-width": "^4.1.0" - }, - "dependencies": { - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - }, - "string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - } - } - } - }, "ansi-colors": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", @@ -19145,22 +16020,6 @@ "picomatch": "^2.0.4" } }, - "aproba": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/aproba/-/aproba-2.0.0.tgz", - "integrity": "sha512-lYe4Gx7QT+MKGbDsA+Z+he/Wtef0BiwDOlK/XkBrdfsh9J/jPPXbX0tE9x9cl27Tmu5gg3QUbUrQYa/y+KOHPQ==", - "dev": true - }, - "are-we-there-yet": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/are-we-there-yet/-/are-we-there-yet-3.0.1.tgz", - "integrity": "sha512-QZW4EDmGwlYur0Yyf/b2uGucHQMa8aFUP7eu9ddR73vvhFyt4V0Vl3QHPcTNJ8l6qYOBdxgXdnBXQrHilfRQBg==", - "dev": true, - "requires": { - "delegates": "^1.0.0", - "readable-stream": "^3.6.0" - } - }, "arg": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", @@ -19173,13 +16032,13 @@ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" }, "array-buffer-byte-length": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.0.tgz", - "integrity": "sha512-LPuwb2P+NrQw3XhxGc36+XSvuBPopovXYTR9Ew++Du9Yb/bx5AzBfrIsBoj0EZUifjQU+sHL21sseZ3jerWO/A==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.1.tgz", + "integrity": "sha512-ahC5W1xgou+KTXix4sAO8Ki12Q+jf4i0+tmk3sC+zgcynshkHxzpXdImBehiUYKKKDwvfFiJl1tZt6ewscS1Mg==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "is-array-buffer": "^3.0.1" + "call-bind": "^1.0.5", + "is-array-buffer": "^3.0.4" } }, "array-ify": { @@ -19189,35 +16048,31 @@ "dev": true }, "array-includes": { - "version": "3.1.7", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.7.tgz", - "integrity": "sha512-dlcsNBIiWhPkHdOEEKnehA+RNUWDc4UqFtnIXU4uuYDPtA4LDkr7qip2p0VvFAEXNDr0yWZ9PJyIRiGjRLQzwQ==", + "version": "3.1.8", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", + "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "get-intrinsic": "^1.2.1", + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0", + "get-intrinsic": "^1.2.4", "is-string": "^1.0.7" } }, - "array-union": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", - "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", - "dev": true - }, "array.prototype.findlastindex": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.3.tgz", - "integrity": "sha512-LzLoiOMAxvy+Gd3BAq3B7VeIgPdo+Q8hthvKtXybMvRV0jrXfJM/t8mw7nNlpEcVlVUnCnM2KSX4XU5HmpodOA==", + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/array.prototype.findlastindex/-/array.prototype.findlastindex-1.2.5.tgz", + "integrity": "sha512-zfETvRFA8o7EiNn++N5f/kaCw221hrpGsDmcpndVupkPzEc1Wuf3VgC0qby1BbHs7f5DVYjgtEU2LLh5bqeGfQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "es-shim-unscopables": "^1.0.0", - "get-intrinsic": "^1.2.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-shim-unscopables": "^1.0.2" } }, "array.prototype.flat": { @@ -19245,17 +16100,18 @@ } }, "arraybuffer.prototype.slice": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.2.tgz", - "integrity": "sha512-yMBKppFur/fbHu9/6USUe03bZ4knMYiwFBcyiaXB8Go0qNehwX6inYPzK9U0NeQvGxKthcmHcaR8P5MStSRBAw==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.3.tgz", + "integrity": "sha512-bMxMKAjg13EBSVscxTaYA4mRc5t1UAXa2kXiGTNfZ079HIWXEkKmkgFrh/nJqamaLSrXO5H4WFFkPEaLJWbs3A==", "dev": true, "requires": { - "array-buffer-byte-length": "^1.0.0", - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "get-intrinsic": "^1.2.1", - "is-array-buffer": "^3.0.2", + "array-buffer-byte-length": "^1.0.1", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", + "es-abstract": "^1.22.3", + "es-errors": "^1.2.1", + "get-intrinsic": "^1.2.3", + "is-array-buffer": "^3.0.4", "is-shared-array-buffer": "^1.0.2" } }, @@ -19304,9 +16160,9 @@ "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, "audit-ci": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/audit-ci/-/audit-ci-7.0.0.tgz", - "integrity": "sha512-sdH5/9EYhmfLdtJpUE3npkyN435b5g5RGTQku5UoALyl3GZEwLeN5KD2QlzZ/oDWbGVOro+VLNohoIN6ucz+2Q==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/audit-ci/-/audit-ci-7.1.0.tgz", + "integrity": "sha512-PjjEejlST57S/aDbeWLic0glJ8CNl/ekY3kfGFPMrPkmuaYaDKcMH0F9x9yS9Vp6URhuefSCubl/G0Y2r6oP0g==", "dev": true, "requires": { "cross-spawn": "^7.0.3", @@ -19321,10 +16177,13 @@ } }, "available-typed-arrays": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz", - "integrity": "sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==", - "dev": true + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", + "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "dev": true, + "requires": { + "possible-typed-array-names": "^1.0.0" + } }, "babel-jest": { "version": "29.7.0", @@ -19419,74 +16278,6 @@ "integrity": "sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==", "dev": true }, - "boxen": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-7.0.0.tgz", - "integrity": "sha512-j//dBVuyacJbvW+tvZ9HuH03fZ46QcaKvvhZickZqtB271DxJ7SNRSNxrV/dZX0085m7hISRZWbzWlJvx/rHSg==", - "dev": true, - "requires": { - "ansi-align": "^3.0.1", - "camelcase": "^7.0.0", - "chalk": "^5.0.1", - "cli-boxes": "^3.0.0", - "string-width": "^5.1.2", - "type-fest": "^2.13.0", - "widest-line": "^4.0.1", - "wrap-ansi": "^8.0.1" - }, - "dependencies": { - "ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true - }, - "ansi-styles": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.1.0.tgz", - "integrity": "sha512-VbqNsoz55SYGczauuup0MFUyXNQviSpFTj1RQtFzmQLk18qbVSpTFFGMT293rmDaQuKCT6InmbuEyUne4mTuxQ==", - "dev": true - }, - "camelcase": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-7.0.0.tgz", - "integrity": "sha512-JToIvOmz6nhGsUhAYScbo2d6Py5wojjNfoxoc2mEVLUdJ70gJK2gnd+ABY1Tc3sVMyK7QDPtN0T/XdlCQWITyQ==", - "dev": true - }, - "chalk": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.0.1.tgz", - "integrity": "sha512-Fo07WOYGqMfCWHOzSXOt2CxDbC6skS/jO9ynEcmpANMoPrD+W1r1K6Vx7iNm+AQmETU1Xr2t+n8nzkV9t6xh3w==", - "dev": true - }, - "strip-ansi": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz", - "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==", - "dev": true, - "requires": { - "ansi-regex": "^6.0.1" - } - }, - "type-fest": { - "version": "2.16.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.16.0.tgz", - "integrity": "sha512-qpaThT2HQkFb83gMOrdKVsfCN7LKxP26Yq+smPzY1FqoHRjqmjqHXA7n5Gkxi8efirtbeEUxzfEdePthQWCuHw==", - "dev": true - }, - "wrap-ansi": { - "version": "8.0.1", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.0.1.tgz", - "integrity": "sha512-QFF+ufAqhoYHvoHdajT/Po7KoXVBPXS2bgjIam5isfWJPfIOnQZ50JtUiVvCv/sjgacf3yRrt2ZKUZ/V4itN4g==", - "dev": true, - "requires": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" - } - } - } - }, "brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -19642,127 +16433,27 @@ "resolved": "https://registry.npmjs.org/builtins/-/builtins-5.0.1.tgz", "integrity": "sha512-qwVpFEHNfhYJIzNRBvd2C1kyo6jz3ZSMPyyuR47OPdiKWlbYnZNyDWuyR175qDnAJLiCo5fBBqPb3RiXgWlkOQ==", "dev": true, + "peer": true, "requires": { "semver": "^7.0.0" } }, "bytes": { "version": "3.1.2", - "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", - "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", - "dev": true - }, - "cacache": { - "version": "17.1.4", - "resolved": "https://registry.npmjs.org/cacache/-/cacache-17.1.4.tgz", - "integrity": "sha512-/aJwG2l3ZMJ1xNAnqbMpA40of9dj/pIH3QfiuQSqjfPJF747VR0J/bHn+/KdNnHKc6XQcWt/AfRSBft82W1d2A==", - "dev": true, - "requires": { - "@npmcli/fs": "^3.1.0", - "fs-minipass": "^3.0.0", - "glob": "^10.2.2", - "lru-cache": "^7.7.1", - "minipass": "^7.0.3", - "minipass-collect": "^1.0.2", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "p-map": "^4.0.0", - "ssri": "^10.0.0", - "tar": "^6.1.11", - "unique-filename": "^3.0.0" - }, - "dependencies": { - "brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "requires": { - "balanced-match": "^1.0.0" - } - }, - "glob": { - "version": "10.3.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.3.tgz", - "integrity": "sha512-92vPiMb/iqpmEgsOoIDvTjc50wf9CCCvMzsi6W0JLPeUKE8TWP1a73PgqSrqy7iAZxaSD1YdzU7QZR5LF51MJw==", - "dev": true, - "requires": { - "foreground-child": "^3.1.0", - "jackspeak": "^2.0.3", - "minimatch": "^9.0.1", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0", - "path-scurry": "^1.10.1" - } - }, - "lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true - }, - "minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "requires": { - "brace-expansion": "^2.0.1" - } - }, - "minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true - } - } - }, - "cacheable-lookup": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-6.0.4.tgz", - "integrity": "sha512-mbcDEZCkv2CZF4G01kr8eBd/5agkt9oCqz75tJMSIsquvRZ2sL6Hi5zGVKi/0OSC9oO1GHfJ2AV0ZIOY9vye0A==", - "dev": true - }, - "cacheable-request": { - "version": "7.0.2", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.2.tgz", - "integrity": "sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew==", - "dev": true, - "requires": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^4.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^6.0.1", - "responselike": "^2.0.0" - }, - "dependencies": { - "get-stream": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", - "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", - "dev": true, - "requires": { - "pump": "^3.0.0" - } - }, - "lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "dev": true - } - } + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "dev": true }, "call-bind": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.5.tgz", - "integrity": "sha512-C3nQxfFZxFRVoJoGKKI8y3MOEo129NQ+FgQ08iye+Mk4zNZZGdjfs06bVTr+DBSlA66Q2VEcMki/cUCP4SercQ==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", "requires": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.1", - "set-function-length": "^1.1.1" + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" } }, "call-me-maybe": { @@ -19815,6 +16506,11 @@ "supports-color": "^7.1.0" } }, + "change-case": { + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", + "integrity": "sha512-HRQyTk2/YPEkt9TnUPbOpr64Uw3KOicFWPVBb+xiHvd6eBx/qPr9xqfBFDT8P2vWsvvz4jbEkfDe71W3VyNu2w==" + }, "char-regex": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/char-regex/-/char-regex-1.0.2.tgz", @@ -19837,12 +16533,6 @@ "readdirp": "~3.6.0" } }, - "chownr": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/chownr/-/chownr-2.0.0.tgz", - "integrity": "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ==", - "dev": true - }, "ci-info": { "version": "3.3.1", "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.3.1.tgz", @@ -19861,60 +16551,13 @@ "integrity": "sha512-CSbhY4cFEJRe6/GQzIk5qXZ4Jeg5pcsP7b5peFSDpffpe1cqjASH/n9UTjBwOp6XpMSTwQ8Za2K5V02ueA7Tmw==", "dev": true }, - "clean-stack": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/clean-stack/-/clean-stack-2.2.0.tgz", - "integrity": "sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==", - "dev": true - }, - "cli-boxes": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", - "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", - "dev": true - }, "cli-cursor": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-4.0.0.tgz", - "integrity": "sha512-VGtlMu3x/4DOtIUwEkRezxUZ2lBacNJCHash0N0WeZDBS+7Ux1dm3XWAgWYxLJFMMdOeXMHXorshEFhbMSGelg==", - "dev": true, - "requires": { - "restore-cursor": "^4.0.0" - } - }, - "cli-table3": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.3.tgz", - "integrity": "sha512-w5Jac5SykAeZJKntOxJCrm63Eg5/4dhMWIcuTbo9rpE+brgaSZo0RuNJZeOyMgsUdhDeojvgyQLmjI+K50ZGyg==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-5.0.0.tgz", + "integrity": "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw==", "dev": true, "requires": { - "@colors/colors": "1.5.0", - "string-width": "^4.2.0" - }, - "dependencies": { - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - }, - "string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - } - } + "restore-cursor": "^5.0.0" } }, "cli-truncate": { @@ -19925,40 +16568,6 @@ "requires": { "slice-ansi": "^5.0.0", "string-width": "^7.0.0" - }, - "dependencies": { - "ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true - }, - "emoji-regex": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz", - "integrity": "sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw==", - "dev": true - }, - "string-width": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz", - "integrity": "sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw==", - "dev": true, - "requires": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", - "strip-ansi": "^7.1.0" - } - }, - "strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "requires": { - "ansi-regex": "^6.0.1" - } - } } }, "cliui": { @@ -19997,15 +16606,6 @@ } } }, - "clone-response": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/clone-response/-/clone-response-1.0.2.tgz", - "integrity": "sha512-yjLXh88P599UOyPTFX0POsd7WxnbsVsGohcwzHOLspIhhpalPw1BcqED8NblyZLKcGrL8dTgMlcaZxV2jAD41Q==", - "dev": true, - "requires": { - "mimic-response": "^1.0.0" - } - }, "clsx": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", @@ -20039,12 +16639,6 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, - "color-support": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-support/-/color-support-1.1.3.tgz", - "integrity": "sha512-qiBjkpbMLO/HL68y+lh4q0/O1MZFj2RX6X/KmMa3+gJD3z+WwI1ZzDHysvqHGS3mP6mznPckpXmw1nI9cJjyRg==", - "dev": true - }, "colorette": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", @@ -20078,16 +16672,6 @@ "resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.3.0.tgz", "integrity": "sha512-Rd3se6QB+sO1TwqZjscQrurpEPIfO0/yYnSin6Q/rD3mOutHvUrCAhJub3r90uNb+SESBuE0QYoB90YdfatsRg==" }, - "compress-brotli": { - "version": "1.3.8", - "resolved": "https://registry.npmjs.org/compress-brotli/-/compress-brotli-1.3.8.tgz", - "integrity": "sha512-lVcQsjhxhIXsuupfy9fmZUFtAIdBmXA7EGY6GBdgZ++qkM9zG4YFT8iU7FoBxzryNDMOpD1HIFHUSX4D87oqhQ==", - "dev": true, - "requires": { - "@types/json-buffer": "~3.0.0", - "json-buffer": "~3.0.1" - } - }, "concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", @@ -20106,52 +16690,6 @@ "typedarray": "^0.0.6" } }, - "config-chain": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", - "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", - "dev": true, - "requires": { - "ini": "^1.3.4", - "proto-list": "~1.2.1" - } - }, - "configstore": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-6.0.0.tgz", - "integrity": "sha512-cD31W1v3GqUlQvbBCGcXmd2Nj9SvLDOP1oQ0YFuLETufzSPaKp11rYBsSOm7rCsW3OnIRAFM3OxRhceaXNYHkA==", - "dev": true, - "requires": { - "dot-prop": "^6.0.1", - "graceful-fs": "^4.2.6", - "unique-string": "^3.0.0", - "write-file-atomic": "^3.0.3", - "xdg-basedir": "^5.0.1" - }, - "dependencies": { - "dot-prop": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-6.0.1.tgz", - "integrity": "sha512-tE7ztYzXHIeyvc7N+hR3oi7FIbf/NIjVP9hmAt3yMXzrQ072/fpjGLx2GxNxGxUl5V73MEqYzioOMoVhGMJ5cA==", - "dev": true, - "requires": { - "is-obj": "^2.0.0" - } - }, - "write-file-atomic": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", - "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", - "dev": true, - "requires": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } - } - } - }, "connect": { "version": "3.6.6", "resolved": "https://registry.npmjs.org/connect/-/connect-3.6.6.tgz", @@ -20187,12 +16725,6 @@ "integrity": "sha512-e54B99q/OUoH64zYYRf3HBP5z24G38h5D3qXu23JGRoigpX5Ss4r9ZnDk3g0Z8uQC2x2lPaJ+UlWBc1ZWBWdLg==", "dev": true }, - "console-control-strings": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz", - "integrity": "sha512-ty/fTekppD2fIwRvnZAVdeOiGd1c7YXEixbgJTNzqcxJWKQnjJ/V1bNEEE6hygpM3WjwHFUVK6HTjWSzV4a8sQ==", - "dev": true - }, "conventional-changelog": { "version": "3.1.25", "resolved": "https://registry.npmjs.org/conventional-changelog/-/conventional-changelog-3.1.25.tgz", @@ -20603,23 +17135,6 @@ "which": "^2.0.1" } }, - "crypto-random-string": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-4.0.0.tgz", - "integrity": "sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==", - "dev": true, - "requires": { - "type-fest": "^1.0.1" - }, - "dependencies": { - "type-fest": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-1.4.0.tgz", - "integrity": "sha512-yGSza74xk0UG8k+pLh5oeoYirvIiWo5t0/o3zHHAO2tRDiZcxWP7fywNlXhqb6/r6sWvwi+RsyQMWhVLe4BVuA==", - "dev": true - } - } - }, "css-color-keywords": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/css-color-keywords/-/css-color-keywords-1.0.0.tgz", @@ -20649,6 +17164,39 @@ "integrity": "sha512-2iy1EkLdlBzQGvbweYRFxmFath8+K7+AKB0TlhHWkNuH+TmovaMH/Wp7V7R4u7f4SnX3OgLsU9t1NI9ioDnUpg==", "dev": true }, + "data-view-buffer": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.1.tgz", + "integrity": "sha512-0lht7OugA5x3iJLOWFhWK/5ehONdprk0ISXqVFn/NFrDu+cuc8iADFrGQz5BnRK7LLU3JmkbXSxaqX+/mXYtUA==", + "dev": true, + "requires": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + } + }, + "data-view-byte-length": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.1.tgz", + "integrity": "sha512-4J7wRJD3ABAzr8wP+OcIcqq2dlUKp4DVflx++hs5h5ZKydWMI6/D/fAot+yh6g2tHh8fLFTvNOaVN357NvSrOQ==", + "dev": true, + "requires": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + } + }, + "data-view-byte-offset": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.0.tgz", + "integrity": "sha512-t/Ygsytq+R995EJ5PZlD4Cu56sWa8InXySaViRzw9apusqsOO2bQP+SbYzAhR0pFKoB+43lYy8rWban9JSuXnA==", + "dev": true, + "requires": { + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", + "is-data-view": "^1.0.1" + } + }, "dateformat": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/dateformat/-/dateformat-3.0.3.tgz", @@ -20656,12 +17204,11 @@ "dev": true }, "debug": { - "version": "4.3.4", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz", - "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==", - "dev": true, + "version": "4.3.7", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", + "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", "requires": { - "ms": "2.1.2" + "ms": "^2.1.3" } }, "decamelize": { @@ -20694,23 +17241,6 @@ "integrity": "sha512-m8FnyHXV1QX+S1cl+KPFDIl6NMkxtKsy6+U/aYyjrOqWMuwAwYWu7ePqrsUHtDR5Y8Yk2pi/KIDSgF+vT4cPOQ==", "dev": true }, - "decompress-response": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz", - "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==", - "dev": true, - "requires": { - "mimic-response": "^3.1.0" - }, - "dependencies": { - "mimic-response": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz", - "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==", - "dev": true - } - } - }, "dedent": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.5.1.tgz", @@ -20718,12 +17248,6 @@ "dev": true, "requires": {} }, - "deep-extend": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", - "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", - "dev": true - }, "deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -20736,20 +17260,14 @@ "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", "dev": true }, - "defer-to-connect": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-2.0.1.tgz", - "integrity": "sha512-4tvttepXG1VaYGrRibk5EwJd1t4udunSOVMdLSAL6mId1ix438oPwPZMALY41FCijukO1L0twNcGsdzS7dHgDg==", - "dev": true - }, "define-data-property": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.1.tgz", - "integrity": "sha512-E7uGkTzkk1d0ByLeSc6ZsFS79Axg+m1P/VsgYsxHgiuc3tFSj+MjMIwe90FC4lOAZzNBdY7kkO2P2wKdsQ1vgQ==", + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", "requires": { - "get-intrinsic": "^1.2.1", - "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.0" + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" } }, "define-properties": { @@ -20768,12 +17286,6 @@ "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", "integrity": "sha1-3zrhmayt+31ECqrgsp4icrJOxhk=" }, - "delegates": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/delegates/-/delegates-1.0.0.tgz", - "integrity": "sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==", - "dev": true - }, "depd": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", @@ -20805,9 +17317,9 @@ "dev": true }, "diff": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/diff/-/diff-5.2.0.tgz", - "integrity": "sha512-uIFDxqpRZGZ6ThOk84hEfqWoHx2devRFvpTZcTHur85vImfaxUbTW9Ryh4CpCuDnToOP1CEtXKIgytHBPVff5A==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/diff/-/diff-7.0.0.tgz", + "integrity": "sha512-PJWHUb1RFevKCwaFA9RlG5tCd+FO5iRh9A8HEtkmBH2Li03iJriB6m6JIN4rGz3K3JLawI7/veA1xzRKP6ISBw==", "dev": true }, "diff-sequences": { @@ -20816,15 +17328,6 @@ "integrity": "sha512-EjePK1srD3P08o2j4f0ExnylqRs5B9tJjcp9t1krH2qRi8CCdsYfwe9JgSLurFBWwq4uOlipzfk5fHNvwFKr8Q==", "dev": true }, - "dir-glob": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", - "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", - "dev": true, - "requires": { - "path-type": "^4.0.0" - } - }, "doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -20910,12 +17413,6 @@ "integrity": "sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==", "dev": true }, - "eastasianwidth": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true - }, "easy-extender": { "version": "2.3.4", "resolved": "https://registry.npmjs.org/easy-extender/-/easy-extender-2.3.4.tgz", @@ -20940,6 +17437,15 @@ "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", "dev": true }, + "ejs": { + "version": "3.1.10", + "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", + "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", + "dev": true, + "requires": { + "jake": "^10.8.5" + } + }, "electron-to-chromium": { "version": "1.4.247", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.4.247.tgz", @@ -20953,9 +17459,9 @@ "dev": true }, "emoji-regex": { - "version": "9.2.2", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", - "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", + "version": "10.4.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz", + "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==", "dev": true }, "encodeurl": { @@ -20969,19 +17475,11 @@ "resolved": "https://registry.npmjs.org/encoding/-/encoding-0.1.13.tgz", "integrity": "sha512-ETBauow1T35Y/WZMkio9jiM0Z5xjHHmJ4XmjZOq1l/dXz3lr2sRn87nJy20RupqSh1F2m3HHPSp8ShIPQJrJ3A==", "optional": true, + "peer": true, "requires": { "iconv-lite": "^0.6.2" } }, - "end-of-stream": { - "version": "1.4.4", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", - "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", - "dev": true, - "requires": { - "once": "^1.4.0" - } - }, "engine.io": { "version": "6.5.3", "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.5.3.tgz", @@ -21038,9 +17536,9 @@ "dev": true }, "enhanced-resolve": { - "version": "5.13.0", - "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.13.0.tgz", - "integrity": "sha512-eyV8f0y1+bzyfh8xAwW/WTSZpLbjhqc4ne9eGSH4Zo2ejdyiNG9pU6mf9DG8a7+Auk6MFTlNOT4Y2y/9k8GKVg==", + "version": "5.17.1", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.17.1.tgz", + "integrity": "sha512-LMHl3dXhTcfv8gM4kEzIUeTQ+7fpdA0l2tUf34BddXPkz2A5xJ5L/Pchd5BL6rdccM9QGvu0sWZzK1Z1t4wwyg==", "dev": true, "requires": { "graceful-fs": "^4.2.4", @@ -21053,10 +17551,10 @@ "integrity": "sha512-+h1lkLKhZMTYjog1VEpJNG7NZJWcuc2DDk/qsqSTRRCOXiLjeQ1d1/udrUGhqMxUgAlwKNZ0cf2uqan5GLuS2A==", "dev": true }, - "err-code": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz", - "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==", + "environment": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/environment/-/environment-1.1.0.tgz", + "integrity": "sha512-xUtoPkMggbz0MPyPiIWr1Kp4aeWJjDZ6SMvURhimjdZgsRuDplF5/s9hcgGhyXMhs+6vpnuoiZ2kFiu3FMnS8Q==", "dev": true }, "error-ex": { @@ -21069,61 +17567,90 @@ } }, "es-abstract": { - "version": "1.22.3", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.22.3.tgz", - "integrity": "sha512-eiiY8HQeYfYH2Con2berK+To6GrK2RxbPawDkGq4UiCQQfZHb6wX9qQqkbpPqaxQFcl8d9QzZqo0tGE0VcrdwA==", - "dev": true, - "requires": { - "array-buffer-byte-length": "^1.0.0", - "arraybuffer.prototype.slice": "^1.0.2", - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.5", - "es-set-tostringtag": "^2.0.1", + "version": "1.23.3", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.3.tgz", + "integrity": "sha512-e+HfNH61Bj1X9/jLc5v1owaLYuHdeHHSQlkhCBiTK8rBvKaULl/beGMxwrMXjpYrv4pz22BlY570vVePA2ho4A==", + "dev": true, + "requires": { + "array-buffer-byte-length": "^1.0.1", + "arraybuffer.prototype.slice": "^1.0.3", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", + "data-view-buffer": "^1.0.1", + "data-view-byte-length": "^1.0.1", + "data-view-byte-offset": "^1.0.0", + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "es-object-atoms": "^1.0.0", + "es-set-tostringtag": "^2.0.3", "es-to-primitive": "^1.2.1", "function.prototype.name": "^1.1.6", - "get-intrinsic": "^1.2.2", - "get-symbol-description": "^1.0.0", + "get-intrinsic": "^1.2.4", + "get-symbol-description": "^1.0.2", "globalthis": "^1.0.3", "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.0", - "has-proto": "^1.0.1", + "has-property-descriptors": "^1.0.2", + "has-proto": "^1.0.3", "has-symbols": "^1.0.3", - "hasown": "^2.0.0", - "internal-slot": "^1.0.5", - "is-array-buffer": "^3.0.2", + "hasown": "^2.0.2", + "internal-slot": "^1.0.7", + "is-array-buffer": "^3.0.4", "is-callable": "^1.2.7", - "is-negative-zero": "^2.0.2", + "is-data-view": "^1.0.1", + "is-negative-zero": "^2.0.3", "is-regex": "^1.1.4", - "is-shared-array-buffer": "^1.0.2", + "is-shared-array-buffer": "^1.0.3", "is-string": "^1.0.7", - "is-typed-array": "^1.1.12", + "is-typed-array": "^1.1.13", "is-weakref": "^1.0.2", "object-inspect": "^1.13.1", "object-keys": "^1.1.1", - "object.assign": "^4.1.4", - "regexp.prototype.flags": "^1.5.1", - "safe-array-concat": "^1.0.1", - "safe-regex-test": "^1.0.0", - "string.prototype.trim": "^1.2.8", - "string.prototype.trimend": "^1.0.7", - "string.prototype.trimstart": "^1.0.7", - "typed-array-buffer": "^1.0.0", - "typed-array-byte-length": "^1.0.0", - "typed-array-byte-offset": "^1.0.0", - "typed-array-length": "^1.0.4", + "object.assign": "^4.1.5", + "regexp.prototype.flags": "^1.5.2", + "safe-array-concat": "^1.1.2", + "safe-regex-test": "^1.0.3", + "string.prototype.trim": "^1.2.9", + "string.prototype.trimend": "^1.0.8", + "string.prototype.trimstart": "^1.0.8", + "typed-array-buffer": "^1.0.2", + "typed-array-byte-length": "^1.0.1", + "typed-array-byte-offset": "^1.0.2", + "typed-array-length": "^1.0.6", "unbox-primitive": "^1.0.2", - "which-typed-array": "^1.1.13" + "which-typed-array": "^1.1.15" + } + }, + "es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "requires": { + "get-intrinsic": "^1.2.4" + } + }, + "es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==" + }, + "es-object-atoms": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.0.0.tgz", + "integrity": "sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==", + "dev": true, + "requires": { + "es-errors": "^1.3.0" } }, "es-set-tostringtag": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.2.tgz", - "integrity": "sha512-BuDyupZt65P9D2D2vA/zqcI3G5xRsklm5N3xCwuiy+/vKy8i0ifdsQP1sLgO4tZDSCaQUSnmC48khknGMV3D2Q==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.3.tgz", + "integrity": "sha512-3T8uNMC3OQTHkFUsFq8r/BwAXLHvU/9O9mE0fBc/MY5iq/8H7ncvO947LmYA6ldWw9Uh8Yhf25zu6n7nML5QWQ==", "dev": true, "requires": { - "get-intrinsic": "^1.2.2", - "has-tostringtag": "^1.0.0", - "hasown": "^2.0.0" + "get-intrinsic": "^1.2.4", + "has-tostringtag": "^1.0.2", + "hasown": "^2.0.1" } }, "es-shim-unscopables": { @@ -21158,12 +17685,6 @@ "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", "dev": true }, - "escape-goat": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", - "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", - "dev": true - }, "escape-html": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", @@ -21288,24 +17809,25 @@ } }, "eslint-import-resolver-typescript": { - "version": "3.6.1", - "resolved": "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-3.6.1.tgz", - "integrity": "sha512-xgdptdoi5W3niYeuQxKmzVDTATvLYqhpwmykwsh7f6HIOStGWEIL9iqZgQDF9u9OEzrRwR8no5q2VT+bjAujTg==", + "version": "3.6.3", + "resolved": "https://registry.npmjs.org/eslint-import-resolver-typescript/-/eslint-import-resolver-typescript-3.6.3.tgz", + "integrity": "sha512-ud9aw4szY9cCT1EWWdGv1L1XR6hh2PaRWif0j2QjQ0pgTY/69iw+W0Z4qZv5wHahOl8isEr+k/JnyAqNQkLkIA==", "dev": true, "requires": { - "debug": "^4.3.4", - "enhanced-resolve": "^5.12.0", - "eslint-module-utils": "^2.7.4", - "fast-glob": "^3.3.1", - "get-tsconfig": "^4.5.0", - "is-core-module": "^2.11.0", + "@nolyfill/is-core-module": "1.0.39", + "debug": "^4.3.5", + "enhanced-resolve": "^5.15.0", + "eslint-module-utils": "^2.8.1", + "fast-glob": "^3.3.2", + "get-tsconfig": "^4.7.5", + "is-bun-module": "^1.0.2", "is-glob": "^4.0.3" } }, "eslint-module-utils": { - "version": "2.8.0", - "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.8.0.tgz", - "integrity": "sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw==", + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/eslint-module-utils/-/eslint-module-utils-2.10.0.tgz", + "integrity": "sha512-/AXiipjFyfLIUj3E4FR5NEGWoGDZHDfcGzWZkwobRc8fwqUAcy9owTk2LIKwNmtYL8Ad9/XfjSXbGHZ9AJWDEg==", "dev": true, "requires": { "debug": "^3.2.7" @@ -21362,26 +17884,27 @@ } }, "eslint-plugin-import": { - "version": "2.29.1", - "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.29.1.tgz", - "integrity": "sha512-BbPC0cuExzhiMo4Ff1BTVwHpjjv28C5R+btTOGaCRC7UEz801up0JadwkeSk5Ued6TG34uaczuVuH6qyy5YUxw==", + "version": "2.30.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-import/-/eslint-plugin-import-2.30.0.tgz", + "integrity": "sha512-/mHNE9jINJfiD2EKkg1BKyPyUk4zdnT54YgbOgfjSakWT5oyX/qQLVNTkehyfpcMxZXMy1zyonZ2v7hZTX43Yw==", "dev": true, "requires": { - "array-includes": "^3.1.7", - "array.prototype.findlastindex": "^1.2.3", + "@rtsao/scc": "^1.1.0", + "array-includes": "^3.1.8", + "array.prototype.findlastindex": "^1.2.5", "array.prototype.flat": "^1.3.2", "array.prototype.flatmap": "^1.3.2", "debug": "^3.2.7", "doctrine": "^2.1.0", "eslint-import-resolver-node": "^0.3.9", - "eslint-module-utils": "^2.8.0", - "hasown": "^2.0.0", - "is-core-module": "^2.13.1", + "eslint-module-utils": "^2.9.0", + "hasown": "^2.0.2", + "is-core-module": "^2.15.1", "is-glob": "^4.0.3", "minimatch": "^3.1.2", - "object.fromentries": "^2.0.7", - "object.groupby": "^1.0.1", - "object.values": "^1.1.7", + "object.fromentries": "^2.0.8", + "object.groupby": "^1.0.3", + "object.values": "^1.2.0", "semver": "^6.3.1", "tsconfig-paths": "^3.15.0" }, @@ -21477,19 +18000,19 @@ } }, "eslint-plugin-prettier": { - "version": "5.1.3", - "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.1.3.tgz", - "integrity": "sha512-C9GCVAs4Eq7ZC/XFQHITLiHJxQngdtraXaM+LoUFoFp/lHNl2Zn8f3WQbe9HvTBBQ9YnKFB0/2Ajdqwo5D1EAw==", + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-5.2.1.tgz", + "integrity": "sha512-gH3iR3g4JfF+yYPaJYkN7jEl9QbweL/YfkoRlNnuIEHEz1vHVlCmWOS+eGGiRuzHQXdJFCOTxRgvju9b8VUmrw==", "dev": true, "requires": { "prettier-linter-helpers": "^1.0.0", - "synckit": "^0.8.6" + "synckit": "^0.9.1" } }, "eslint-plugin-promise": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.2.0.tgz", - "integrity": "sha512-QmAqwizauvnKOlifxyDj2ObfULpHQawlg/zQdgEixur9vl0CvZGv/LCJV2rtj3210QCoeGBzVMfMXqGAOr/4fA==", + "version": "6.6.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-promise/-/eslint-plugin-promise-6.6.0.tgz", + "integrity": "sha512-57Zzfw8G6+Gq7axm2Pdo3gW/Rx3h9Yywgn61uE/3elTCOePEHVrn2i5CdfBwA1BLK0Q0WqctICIUSqXZW/VprQ==", "dev": true, "requires": {} }, @@ -21650,12 +18173,6 @@ "integrity": "sha1-uNIlub9nap6H4G29YVtS/J0eOGs=", "dev": true }, - "exponential-backoff": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/exponential-backoff/-/exponential-backoff-3.1.1.tgz", - "integrity": "sha512-dX7e/LHVJ6W3DE1MHWi9S1EYzDESENfLrYohG2G++ovZrYOkm4Knwa0mc1cn84xJOR4KEU0WSchhLbd0UklbHw==", - "dev": true - }, "extend": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz", @@ -21676,6 +18193,7 @@ "version": "3.3.2", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "dev": true, "requires": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -21696,12 +18214,6 @@ "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", "dev": true }, - "fast-memoize": { - "version": "2.5.2", - "resolved": "https://registry.npmjs.org/fast-memoize/-/fast-memoize-2.5.2.tgz", - "integrity": "sha512-Ue0LwpDYErFbmNnZSF0UH6eImUwDmogUO1jyE+JbN2gsQz/jICm1Ve7t9QT0rNSsfJt+Hs4/S3GnsDVjL4HVrw==", - "dev": true - }, "fast-safe-stringify": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz", @@ -21712,6 +18224,7 @@ "version": "1.13.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, "requires": { "reusify": "^1.0.4" } @@ -21751,6 +18264,35 @@ "flat-cache": "^3.0.4" } }, + "filelist": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz", + "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==", + "dev": true, + "requires": { + "minimatch": "^5.0.1" + }, + "dependencies": { + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "requires": { + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "requires": { + "brace-expansion": "^2.0.1" + } + } + } + }, "fill-range": { "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", @@ -21835,26 +18377,8 @@ "foreach": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/foreach/-/foreach-2.0.6.tgz", - "integrity": "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg==", - "dev": true - }, - "foreground-child": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz", - "integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==", - "dev": true, - "requires": { - "cross-spawn": "^7.0.0", - "signal-exit": "^4.0.1" - }, - "dependencies": { - "signal-exit": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", - "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true - } - } + "integrity": "sha512-k6GAGDyqLe9JaebCsFCoudPPWfihKu8pylYXRlqP1J7ms39iPoTtk2fviNglIeQEwdh0bQeKJ01ZPyuyQvKzwg==", + "dev": true }, "form-data": { "version": "2.5.1", @@ -21866,23 +18390,11 @@ "mime-types": "^2.1.12" } }, - "form-data-encoder": { - "version": "1.7.1", - "resolved": "https://registry.npmjs.org/form-data-encoder/-/form-data-encoder-1.7.1.tgz", - "integrity": "sha512-EFRDrsMm/kyqbTQocNvRXMLjc7Es2Vk+IQFx/YW7hkUH1eBl4J1fqiP34l74Yt0pFLCNpc06fkbVk00008mzjg==", - "dev": true - }, "formidable": { "version": "1.2.6", "resolved": "https://registry.npmjs.org/formidable/-/formidable-1.2.6.tgz", "integrity": "sha512-KcpbcpuLNOwrEjnbpMC0gS+X8ciDoZE1kkqzat4a8vrprf+s9pKNQ/QIwWfbfs4ltgmFl3MD177SNTkve3BwGQ==" }, - "fp-and-or": { - "version": "0.1.4", - "resolved": "https://registry.npmjs.org/fp-and-or/-/fp-and-or-0.1.4.tgz", - "integrity": "sha512-+yRYRhpnFPWXSly/6V4Lw9IfOV26uu30kynGJ03PW+MnjOEQe45RZ141QcS0aJehYBYA50GfCDnsRbFJdhssRw==", - "dev": true - }, "fresh": { "version": "0.5.2", "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", @@ -21895,23 +18407,6 @@ "integrity": "sha512-twe20eF1OxVxp/ML/kq2p1uc6KvFK/+vs8WjEbeKmV2He22MKm7YF2ANIt+EOqhJ5L3K/SuuPhk0hWQDjOM23g==", "dev": true }, - "fs-minipass": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-3.0.3.tgz", - "integrity": "sha512-XUBA9XClHbnJWSfBzjkm6RvPsyg3sryZt06BEQoXcF7EK/xpGaQYJgQKDJSUH5SGZ76Y7pFx1QBnXz09rU5Fbw==", - "dev": true, - "requires": { - "minipass": "^7.0.3" - }, - "dependencies": { - "minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true - } - } - }, "fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -21948,47 +18443,6 @@ "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", "dev": true }, - "gauge": { - "version": "4.0.4", - "resolved": "https://registry.npmjs.org/gauge/-/gauge-4.0.4.tgz", - "integrity": "sha512-f9m+BEN5jkg6a0fZjleidjN51VE1X+mPFQ2DJ0uv1V39oCLCbsGe6yjbBnp7eK7z/+GAon99a3nHuqbuuthyPg==", - "dev": true, - "requires": { - "aproba": "^1.0.3 || ^2.0.0", - "color-support": "^1.1.3", - "console-control-strings": "^1.1.0", - "has-unicode": "^2.0.1", - "signal-exit": "^3.0.7", - "string-width": "^4.2.3", - "strip-ansi": "^6.0.1", - "wide-align": "^1.1.5" - }, - "dependencies": { - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - }, - "string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - } - } - } - }, "gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -22008,10 +18462,11 @@ "dev": true }, "get-intrinsic": { - "version": "1.2.2", - "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.2.tgz", - "integrity": "sha512-0gSo4ml/0j98Y3lngkFEot/zhiCeWsbYIlZ+uZOVgzLyLaUw7wxUL+nCTP0XJvJg1AXulJRI3UJi8GsbDuxdGA==", + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", "requires": { + "es-errors": "^1.3.0", "function-bind": "^1.1.2", "has-proto": "^1.0.1", "has-symbols": "^1.0.3", @@ -22116,12 +18571,6 @@ "integrity": "sha512-3UBAyM3u4ZBVYDsxOQfJDxEa6XTbpBDrOjp4mf7ExFRt5BKs/QywQQiJsh2B+hxcZLSapWqCRvElUe8DnKcFHA==", "dev": true }, - "get-stdin": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-8.0.0.tgz", - "integrity": "sha512-sY22aA6xchAzprjyqmSEQv4UbAAzRN0L2dQB0NlN5acTTK9Don6nhoc3eAbUnpZiCANAMfd/+40kVdKfFygohg==", - "dev": true - }, "get-stream": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-6.0.1.tgz", @@ -22129,20 +18578,24 @@ "dev": true }, "get-symbol-description": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz", - "integrity": "sha512-2EmdH1YvIQiZpltCNgkuiUnyukzxM/R6NDJX31Ke3BG1Nq5b0S2PhX59UKi9vZpPDQVdqn+1IcaAwnzTT5vCjw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.2.tgz", + "integrity": "sha512-g0QYk1dZBxGwk+Ngc+ltRH2IBp2f7zBkBMBJZCDerh6EhlhSR6+9irMCuT/09zD6qkarHUSn529sK/yL4S27mg==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.1" + "call-bind": "^1.0.5", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4" } }, "get-tsconfig": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.5.0.tgz", - "integrity": "sha512-MjhiaIWCJ1sAU4pIQ5i5OfOuHHxVo1oYeNsWTON7jxYkod8pHocXeh+SSbmu5OZZZK73B6cbJ2XADzXehLyovQ==", - "dev": true + "version": "4.8.0", + "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.8.0.tgz", + "integrity": "sha512-Pgba6TExTZ0FJAn1qkJAjIeKoDJ3CsI2ChuLohJnZl/tTU8MVrq3b+2t5UOPfRa4RMsorClBjJALkJUMjG1PAw==", + "dev": true, + "requires": { + "resolve-pkg-maps": "^1.0.0" + } }, "git-raw-commits": { "version": "2.0.11", @@ -22212,6 +18665,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, "requires": { "is-glob": "^4.0.1" } @@ -22282,20 +18736,6 @@ "define-properties": "^1.1.3" } }, - "globby": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", - "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", - "dev": true, - "requires": { - "array-union": "^2.1.0", - "dir-glob": "^3.0.1", - "fast-glob": "^3.2.9", - "ignore": "^5.2.0", - "merge2": "^1.4.1", - "slash": "^3.0.0" - } - }, "gopd": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", @@ -22304,27 +18744,6 @@ "get-intrinsic": "^1.1.3" } }, - "got": { - "version": "12.1.0", - "resolved": "https://registry.npmjs.org/got/-/got-12.1.0.tgz", - "integrity": "sha512-hBv2ty9QN2RdbJJMK3hesmSkFTjVIHyIDDbssCKnSmq62edGgImJWD10Eb1k77TiV1bxloxqcFAVK8+9pkhOig==", - "dev": true, - "requires": { - "@sindresorhus/is": "^4.6.0", - "@szmarczak/http-timer": "^5.0.1", - "@types/cacheable-request": "^6.0.2", - "@types/responselike": "^1.0.0", - "cacheable-lookup": "^6.0.4", - "cacheable-request": "^7.0.2", - "decompress-response": "^6.0.0", - "form-data-encoder": "1.7.1", - "get-stream": "^6.0.1", - "http2-wrapper": "^2.1.10", - "lowercase-keys": "^3.0.0", - "p-cancelable": "^3.0.0", - "responselike": "^2.0.0" - } - }, "graceful-fs": { "version": "4.2.10", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", @@ -22377,17 +18796,17 @@ "dev": true }, "has-property-descriptors": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.1.tgz", - "integrity": "sha512-VsX8eaIewvas0xnvinAe9bw4WfIeODpGYikiWYLH+dma0Jw6KHYqWiWfhQlgOVK8D6PvjubK5Uc4P0iIhIcNVg==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", "requires": { - "get-intrinsic": "^1.2.2" + "es-define-property": "^1.0.0" } }, "has-proto": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.1.tgz", - "integrity": "sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==" + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==" }, "has-symbols": { "version": "1.0.3", @@ -22395,30 +18814,18 @@ "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==" }, "has-tostringtag": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.0.tgz", - "integrity": "sha512-kFjcSNhnlGV1kyoGk7OXKSawH5JOb/LzUc5w9B02hOTO0dfFRjbHQKvg1d6cf3HbeUmtU9VbbV3qzZ2Teh97WQ==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", + "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", "dev": true, "requires": { - "has-symbols": "^1.0.2" + "has-symbols": "^1.0.3" } }, - "has-unicode": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz", - "integrity": "sha512-8Rf9Y83NBReMnx0gFzA8JImQACstCYWUplepDa9xprwwtmgEZUF0h/i5xSA625zB/I37EtrswSST6OXxwaaIJQ==", - "dev": true - }, - "has-yarn": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-3.0.0.tgz", - "integrity": "sha512-IrsVwUHhEULx3R8f/aA8AHuEzAorplsab/v8HBzEiIukwq5i/EC+xmOW+HfP1OaDP+2JkgT1yILHN2O3UFIbcA==", - "dev": true - }, "hasown": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.0.tgz", - "integrity": "sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", "requires": { "function-bind": "^1.1.2" } @@ -22438,12 +18845,6 @@ "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", "dev": true }, - "http-cache-semantics": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz", - "integrity": "sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==", - "dev": true - }, "http-errors": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz", @@ -22484,48 +18885,18 @@ } } }, - "http-proxy-agent": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-5.0.0.tgz", - "integrity": "sha512-n2hY8YdoRE1i7r6M0w9DIw5GgZN0G25P8zLCRQ8rjXtTU3vsNFBI/vWK/UIeE6g5MUUz6avwAPXmL6Fy9D/90w==", - "dev": true, - "requires": { - "@tootallnate/once": "2", - "agent-base": "6", - "debug": "4" - } - }, "http2-client": { "version": "1.3.5", "resolved": "https://registry.npmjs.org/http2-client/-/http2-client-1.3.5.tgz", "integrity": "sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA==", "dev": true }, - "http2-wrapper": { - "version": "2.1.11", - "resolved": "https://registry.npmjs.org/http2-wrapper/-/http2-wrapper-2.1.11.tgz", - "integrity": "sha512-aNAk5JzLturWEUiuhAN73Jcbq96R7rTitAoXV54FYMatvihnpD2+6PUgU4ce3D/m5VDbw+F5CsyKSF176ptitQ==", - "dev": true, - "requires": { - "quick-lru": "^5.1.1", - "resolve-alpn": "^1.2.0" - }, - "dependencies": { - "quick-lru": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-5.1.1.tgz", - "integrity": "sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==", - "dev": true - } - } - }, "https-proxy-agent": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz", - "integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==", - "dev": true, + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", + "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", "requires": { - "agent-base": "6", + "agent-base": "^7.0.2", "debug": "4" } }, @@ -22535,19 +18906,10 @@ "integrity": "sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==", "dev": true }, - "humanize-ms": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz", - "integrity": "sha512-Fl70vYtsAFb/C06PTS9dZBo7ihau+Tu/DNCk/OyHhea07S+aeMWpFFkUaXRa8fI+ScZbEI8dfSxwY7gxZ9SAVQ==", - "dev": true, - "requires": { - "ms": "^2.0.0" - } - }, "husky": { - "version": "9.0.11", - "resolved": "https://registry.npmjs.org/husky/-/husky-9.0.11.tgz", - "integrity": "sha512-AB6lFlbwwyIqMdHYhwPe+kjOC3Oc5P3nThEoW/AaO2BX3vJDjWPFxYLxokUZOo6RNX20He3AaT8sESs9NJcmEw==", + "version": "9.1.5", + "resolved": "https://registry.npmjs.org/husky/-/husky-9.1.5.tgz", + "integrity": "sha512-rowAVRUBfI0b4+niA4SJMhfQwc107VLkBUgEYYAOQAbqDCnra1nYh83hF/MDmhYs9t9n1E3DuKOrs2LYNC+0Ag==", "dev": true }, "iconv-lite": { @@ -22555,6 +18917,7 @@ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", "optional": true, + "peer": true, "requires": { "safer-buffer": ">= 2.1.2 < 3.0.0" } @@ -22565,35 +18928,6 @@ "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", "dev": true }, - "ignore-walk": { - "version": "6.0.3", - "resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-6.0.3.tgz", - "integrity": "sha512-C7FfFoTA+bI10qfeydT8aZbvr91vAEU+2W5BZUlzPec47oNb07SsOfwYrtxuvOYdUApPP/Qlh4DtAO51Ekk2QA==", - "dev": true, - "requires": { - "minimatch": "^9.0.0" - }, - "dependencies": { - "brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "requires": { - "balanced-match": "^1.0.0" - } - }, - "minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "requires": { - "brace-expansion": "^2.0.1" - } - } - } - }, "immutable": { "version": "3.8.2", "resolved": "https://registry.npmjs.org/immutable/-/immutable-3.8.2.tgz", @@ -22618,12 +18952,6 @@ } } }, - "import-lazy": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", - "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", - "dev": true - }, "import-local": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.1.0.tgz", @@ -22652,6 +18980,11 @@ "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", "dev": true }, + "index-to-position": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-0.1.2.tgz", + "integrity": "sha512-MWDKS3AS1bGCHLBA2VLImJz42f7bJh8wQsTGCzI3j519/CASStoDONUBVz2I/VID0MpiX3SGSnbOD2xUalbE5g==" + }, "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -22674,43 +19007,24 @@ "dev": true }, "internal-slot": { - "version": "1.0.6", - "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.6.tgz", - "integrity": "sha512-Xj6dv+PsbtwyPpEflsejS+oIZxmMlV44zAhG479uYu89MsjcYOhCFnNyKrkJrihbsiasQyY0afoCl/9BLR65bg==", + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.0.7.tgz", + "integrity": "sha512-NGnrKwXzSms2qUUih/ILZ5JBqNTSa1+ZmP6flaIp6KmSElgE9qdndzS3cqjrDovwFdmwsGsLdeFgB6suw+1e9g==", "dev": true, "requires": { - "get-intrinsic": "^1.2.2", + "es-errors": "^1.3.0", "hasown": "^2.0.0", "side-channel": "^1.0.4" } }, - "ip-address": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-9.0.5.tgz", - "integrity": "sha512-zHtQzGojZXTwZTHQqra+ETKd4Sn3vgi7uBmlPoXVWZqYvuKmtI0l/VZTjqGmJY9x88GGOaZ9+G9ES8hC4T4X8g==", - "dev": true, - "requires": { - "jsbn": "1.1.0", - "sprintf-js": "^1.1.3" - }, - "dependencies": { - "sprintf-js": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.3.tgz", - "integrity": "sha512-Oo+0REFV59/rz3gfJNKQiBlwfHaSESl1pcGyABQsnnIfWOFt6JNj5gCog2U6MLZ//IGYD+nA8nI+mTShREReaA==", - "dev": true - } - } - }, "is-array-buffer": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.2.tgz", - "integrity": "sha512-y+FyyR/w8vfIRq4eQcM1EYgSTnmHXPqaF+IgzgraytCFq5Xh8lllDVmAZolPJiZttZLeFSINPYMaEJ7/vWUa1w==", + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", + "integrity": "sha512-wcjaerHw0ydZwfhiKbXJWLDY8A7yV7KhjQOpb83hGgGfId/aQa4TOvwyzn2PuswW2gPCYEL/nEAiSVpdOj1lXw==", "dev": true, "requires": { "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.0", - "is-typed-array": "^1.1.10" + "get-intrinsic": "^1.2.1" } }, "is-arrayish": { @@ -22747,28 +19061,37 @@ "has-tostringtag": "^1.0.0" } }, + "is-bun-module": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/is-bun-module/-/is-bun-module-1.1.0.tgz", + "integrity": "sha512-4mTAVPlrXpaN3jtF0lsnPCMGnq4+qZjVIKq0HCpfcqf8OC1SM5oATCIAPM5V5FN05qp2NNnFndphmdZS9CV3hA==", + "dev": true, + "requires": { + "semver": "^7.6.3" + } + }, "is-callable": { "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", "dev": true }, - "is-ci": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz", - "integrity": "sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==", + "is-core-module": { + "version": "2.15.1", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.1.tgz", + "integrity": "sha512-z0vtXSwucUJtANQWldhbtbt7BnL0vxiFjIdDLAatwhDYty2bad6s+rijD6Ri4YuYJubLzIJLUidCh09e1djEVQ==", "dev": true, "requires": { - "ci-info": "^3.2.0" + "hasown": "^2.0.2" } }, - "is-core-module": { - "version": "2.13.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz", - "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==", + "is-data-view": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.1.tgz", + "integrity": "sha512-AHkaJrsUVW6wq6JS8y3JnM/GJF/9cf+k20+iDzlSaJrinEo5+7vRiteOSwBhHRiAyQATN1AmY4hwzxJKPmYf+w==", "dev": true, "requires": { - "hasown": "^2.0.0" + "is-typed-array": "^1.1.13" } }, "is-date-object": { @@ -22783,7 +19106,8 @@ "is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=" + "integrity": "sha1-qIwCU1eR8C7TfHahueqXc8gz+MI=", + "dev": true }, "is-fullwidth-code-point": { "version": "4.0.0", @@ -22801,53 +19125,15 @@ "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", - "requires": { - "is-extglob": "^2.1.1" - } - }, - "is-installed-globally": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.4.0.tgz", - "integrity": "sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==", "dev": true, "requires": { - "global-dirs": "^3.0.0", - "is-path-inside": "^3.0.2" - }, - "dependencies": { - "global-dirs": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.0.tgz", - "integrity": "sha512-v8ho2DS5RiCjftj1nD9NmnfaOzTdud7RRnVd9kFNOjqZbISlx5DQ+OrTkywgd0dIt7oFCvKetZSHoHcP3sDdiA==", - "dev": true, - "requires": { - "ini": "2.0.0" - } - }, - "ini": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ini/-/ini-2.0.0.tgz", - "integrity": "sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==", - "dev": true - } + "is-extglob": "^2.1.1" } }, - "is-lambda": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/is-lambda/-/is-lambda-1.0.1.tgz", - "integrity": "sha512-z7CMFGNrENq5iFB9Bqo64Xk6Y9sg+epq1myIcdHaGnbMTYOxvzsEtdYqQUylB7LxfkvgrrjP32T6Ywciio9UIQ==", - "dev": true - }, "is-negative-zero": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.2.tgz", - "integrity": "sha512-dqJvarLawXsFbNDeJW7zAz8ItJ9cd28YufuuFzh0G8pNHjJMnY08Dv7sYX2uF5UpQOwieAeOExEYAWWfu7ZZUA==", - "dev": true - }, - "is-npm": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.0.0.tgz", - "integrity": "sha512-JEjxbSmtPSt1c8XTkVrlujcXdKV1/tvuQ7GwKcAlyiVLeYFQ2VHat8xfrDJsIkhCdF/tZ7CiIR3sy141c6+gPQ==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", "dev": true }, "is-number": { @@ -22902,12 +19188,12 @@ } }, "is-shared-array-buffer": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.2.tgz", - "integrity": "sha512-sqN2UDu1/0y6uvXyStCOzyhAjCSlHceFoMKJW8W9EU9cvic/QdsZ0kEU93HEy3IUEFZIiH/3w+AH/UQbPHNdhA==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.3.tgz", + "integrity": "sha512-nA2hv5XIhLR3uVzDDfCIknerhx8XUKnstuOERPNNIinXG7v9u+ohXF67vxm4TPTEPU6lm61ZkwP3c9PCB97rhg==", "dev": true, "requires": { - "call-bind": "^1.0.2" + "call-bind": "^1.0.7" } }, "is-stream": { @@ -22944,20 +19230,14 @@ } }, "is-typed-array": { - "version": "1.1.12", - "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.12.tgz", - "integrity": "sha512-Z14TF2JNG8Lss5/HMqt0//T9JeHXttXy5pH/DBU4vi98ozO2btxzq9MwYDZYnKwU8nRsz/+GVFVRDq3DkVuSPg==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", + "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", "dev": true, "requires": { - "which-typed-array": "^1.1.11" + "which-typed-array": "^1.1.14" } }, - "is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==", - "dev": true - }, "is-weakref": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.0.2.tgz", @@ -22967,12 +19247,6 @@ "call-bind": "^1.0.2" } }, - "is-yarn-global": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.4.0.tgz", - "integrity": "sha512-HneQBCrXGBy15QnaDfcn6OLoU8AQPAa0Qn0IeJR/QCo4E8dNZaGGwxpCwWyEBQC5QvFonP8d6t60iGpAHVAfNA==", - "dev": true - }, "isarray": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", @@ -23043,14 +19317,24 @@ "istanbul-lib-report": "^3.0.0" } }, - "jackspeak": { - "version": "2.3.6", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.3.6.tgz", - "integrity": "sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==", + "jake": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz", + "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==", "dev": true, "requires": { - "@isaacs/cliui": "^8.0.2", - "@pkgjs/parseargs": "^0.11.0" + "async": "^3.2.3", + "chalk": "^4.0.2", + "filelist": "^1.0.4", + "minimatch": "^3.1.2" + }, + "dependencies": { + "async": { + "version": "3.2.6", + "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", + "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", + "dev": true + } } }, "jest": { @@ -23498,9 +19782,9 @@ } }, "jiti": { - "version": "1.21.0", - "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.0.tgz", - "integrity": "sha512-gFqAIbuKyyso/3G2qhiO2OM6shY6EPP/R0+mkDbyspxKazh8BXDC5FiFsUjlczgdNz/vfra0da2y+aHrusLG/Q==", + "version": "1.21.6", + "resolved": "https://registry.npmjs.org/jiti/-/jiti-1.21.6.tgz", + "integrity": "sha512-2yTgeWTWzMWkHu6Jp9NKgePDaYHbntiwvYuuJLbbN9vl7DC9DvXKOB2BC3ZZ92D3cvV/aflH0osDfwpHepQ53w==", "dev": true }, "jju": { @@ -23517,8 +19801,7 @@ "js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", - "dev": true + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" }, "js-yaml": { "version": "4.1.0", @@ -23528,24 +19811,12 @@ "argparse": "^2.0.1" } }, - "jsbn": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-1.1.0.tgz", - "integrity": "sha512-4bYVV3aAMtDTTu4+xsDYa6sy9GyJ69/amsu9sYF2zqjiEoZA5xJi3BrfX3uY+/IekIu7MwdObdbDWpoZdBv3/A==", - "dev": true - }, "jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", "integrity": "sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==", "dev": true }, - "json-buffer": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", - "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true - }, "json-parse-better-errors": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/json-parse-better-errors/-/json-parse-better-errors-1.0.2.tgz", @@ -23558,15 +19829,6 @@ "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", "dev": true }, - "json-parse-helpfulerror": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/json-parse-helpfulerror/-/json-parse-helpfulerror-1.0.3.tgz", - "integrity": "sha1-E/FM4C7tTpgSl7ZOueO5MuLdE9w=", - "dev": true, - "requires": { - "jju": "^1.1.0" - } - }, "json-pointer": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/json-pointer/-/json-pointer-0.6.2.tgz", @@ -23638,12 +19900,6 @@ "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", "dev": true }, - "jsonlines": { - "version": "0.1.1", - "resolved": "https://registry.npmjs.org/jsonlines/-/jsonlines-0.1.1.tgz", - "integrity": "sha1-T80kbcXQ44aRkHxEqwAveC0dlMw=", - "dev": true - }, "jsonparse": { "version": "1.3.1", "resolved": "https://registry.npmjs.org/jsonparse/-/jsonparse-1.3.1.tgz", @@ -23670,16 +19926,6 @@ "through2": "^4.0.2" } }, - "keyv": { - "version": "4.3.2", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.3.2.tgz", - "integrity": "sha512-kn8WmodVBe12lmHpA6W8OY7SNh6wVR+Z+wZESF4iF5FCazaVXGWOtnbnvX0tMQ1bO+/TmOD9LziuYMvrIIs0xw==", - "dev": true, - "requires": { - "compress-brotli": "^1.3.8", - "json-buffer": "3.0.1" - } - }, "kind-of": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", @@ -23692,15 +19938,6 @@ "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", "dev": true }, - "latest-version": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-7.0.0.tgz", - "integrity": "sha512-KvNT4XqAMzdcL6ka6Tl3i2lYeFDgXNCuIX+xNx6ZMVR1dFq+idXd9FLKNMOIx0t9mJ9/HudyX4oZWXZQ0UJHeg==", - "dev": true, - "requires": { - "package-json": "^8.1.0" - } - }, "leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -23718,9 +19955,9 @@ } }, "lilconfig": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.1.tgz", - "integrity": "sha512-O18pf7nyvHTckunPWCV1XUNXU1piu01y2b7ATJ0ppkUkk8ocqVWBrYjJBCwHDjD/ZWcfyrA0P4gKhzWGi5EINQ==", + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/lilconfig/-/lilconfig-3.1.2.tgz", + "integrity": "sha512-eop+wDAvpItUys0FWkHIKeC9ybYrTGbU41U5K7+bttZZeohvnY7M9dZ5kB21GNWiFT2q1OoPTvncPCgSOVO5ow==", "dev": true }, "limiter": { @@ -23736,21 +19973,21 @@ "dev": true }, "lint-staged": { - "version": "15.2.5", - "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.5.tgz", - "integrity": "sha512-j+DfX7W9YUvdzEZl3Rk47FhDF6xwDBV5wwsCPw6BwWZVPYJemusQmvb9bRsW23Sqsaa+vRloAWogbK4BUuU2zA==", + "version": "15.2.10", + "resolved": "https://registry.npmjs.org/lint-staged/-/lint-staged-15.2.10.tgz", + "integrity": "sha512-5dY5t743e1byO19P9I4b3x8HJwalIznL5E1FWYnU6OWw33KxNBSLAc6Cy7F2PsFEO8FKnLwjwm5hx7aMF0jzZg==", "dev": true, "requires": { "chalk": "~5.3.0", "commander": "~12.1.0", - "debug": "~4.3.4", + "debug": "~4.3.6", "execa": "~8.0.1", - "lilconfig": "~3.1.1", - "listr2": "~8.2.1", - "micromatch": "~4.0.7", + "lilconfig": "~3.1.2", + "listr2": "~8.2.4", + "micromatch": "~4.0.8", "pidtree": "~0.6.0", "string-argv": "~0.3.2", - "yaml": "~2.4.2" + "yaml": "~2.5.0" }, "dependencies": { "chalk": { @@ -23794,16 +20031,6 @@ "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==", "dev": true }, - "micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", - "dev": true, - "requires": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" - } - }, "mimic-fn": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz", @@ -23849,16 +20076,16 @@ } }, "listr2": { - "version": "8.2.1", - "resolved": "https://registry.npmjs.org/listr2/-/listr2-8.2.1.tgz", - "integrity": "sha512-irTfvpib/rNiD637xeevjO2l3Z5loZmuaRi0L0YE5LfijwVY96oyVn0DFD3o/teAok7nfobMG1THvvcHh/BP6g==", + "version": "8.2.4", + "resolved": "https://registry.npmjs.org/listr2/-/listr2-8.2.4.tgz", + "integrity": "sha512-opevsywziHd3zHCVQGAj8zu+Z3yHNkkoYhWIGnq54RrCVwLz0MozotJEDnKsIBLvkfLGN6BLOyAeRrYI0pKA4g==", "dev": true, "requires": { "cli-truncate": "^4.0.0", "colorette": "^2.0.20", "eventemitter3": "^5.0.1", - "log-update": "^6.0.0", - "rfdc": "^1.3.1", + "log-update": "^6.1.0", + "rfdc": "^1.4.1", "wrap-ansi": "^9.0.0" }, "dependencies": { @@ -23875,27 +20102,10 @@ "dev": true }, "colorette": { - "version": "2.0.20", - "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", - "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", - "dev": true - }, - "emoji-regex": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz", - "integrity": "sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw==", - "dev": true - }, - "string-width": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz", - "integrity": "sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw==", - "dev": true, - "requires": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", - "strip-ansi": "^7.1.0" - } + "version": "2.0.20", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-2.0.20.tgz", + "integrity": "sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==", + "dev": true }, "strip-ansi": { "version": "7.1.0", @@ -24052,23 +20262,26 @@ "dev": true }, "log-update": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/log-update/-/log-update-6.0.0.tgz", - "integrity": "sha512-niTvB4gqvtof056rRIrTZvjNYE4rCUzO6X/X+kYjd7WFxXeJ0NwEFnRxX6ehkvv3jTwrXnNdtAak5XYZuIyPFw==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/log-update/-/log-update-6.1.0.tgz", + "integrity": "sha512-9ie8ItPR6tjY5uYJh8K/Zrv/RMZ5VOlOWvtZdEHYSTFKZfIBPQa9tOAEeAWhd+AnIneLJ22w5fjOYtoutpWq5w==", "dev": true, "requires": { - "ansi-escapes": "^6.2.0", - "cli-cursor": "^4.0.0", - "slice-ansi": "^7.0.0", + "ansi-escapes": "^7.0.0", + "cli-cursor": "^5.0.0", + "slice-ansi": "^7.1.0", "strip-ansi": "^7.1.0", "wrap-ansi": "^9.0.0" }, "dependencies": { "ansi-escapes": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-6.2.1.tgz", - "integrity": "sha512-4nJ3yixlEthEJ9Rk4vPcdBRkZvQZlYyu8j4/Mqz5sgIkddmEnH2Yj2ZrnP9S3tQOvSNRUIgVNF/1yPpRAGNRig==", - "dev": true + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-7.0.0.tgz", + "integrity": "sha512-GdYO7a61mR0fOlAsvC9/rIHf7L96sBc6dEWzeOu+KAea5bZyQRPIpojrVoI4AXGJS/ycu/fBTdLrUkA4ODrvjw==", + "dev": true, + "requires": { + "environment": "^1.0.0" + } }, "ansi-regex": { "version": "6.0.1", @@ -24082,12 +20295,6 @@ "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", "dev": true }, - "emoji-regex": { - "version": "10.3.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.3.0.tgz", - "integrity": "sha512-QpLs9D9v9kArv4lfDEgg1X/gN5XLnf/A6l9cs8SPZLRZR3ZkY9+kwIQTxm+fsSej5UMYGE8fdoaZVIBlqG0XTw==", - "dev": true - }, "is-fullwidth-code-point": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-5.0.0.tgz", @@ -24107,17 +20314,6 @@ "is-fullwidth-code-point": "^5.0.0" } }, - "string-width": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.1.0.tgz", - "integrity": "sha512-SEIJCWiX7Kg4c129n48aDRwLbFb2LJmXXFrWBG4NGaRtMQ3myKPKbwrD1BKqQn74oCoNMBVrfDEr5M9YxCsrkw==", - "dev": true, - "requires": { - "emoji-regex": "^10.3.0", - "get-east-asian-width": "^1.0.0", - "strip-ansi": "^7.1.0" - } - }, "strip-ansi": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", @@ -24149,12 +20345,6 @@ "js-tokens": "^3.0.0 || ^4.0.0" } }, - "lowercase-keys": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-3.0.0.tgz", - "integrity": "sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ==", - "dev": true - }, "lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", @@ -24185,37 +20375,6 @@ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", "dev": true }, - "make-fetch-happen": { - "version": "11.1.1", - "resolved": "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-11.1.1.tgz", - "integrity": "sha512-rLWS7GCSTcEujjVBs2YqG7Y4643u8ucvCJeSRqiLYhesrDuzeuFIk37xREzAsfQaqzl8b9rNCE4m6J8tvX4Q8w==", - "dev": true, - "requires": { - "agentkeepalive": "^4.2.1", - "cacache": "^17.0.0", - "http-cache-semantics": "^4.1.1", - "http-proxy-agent": "^5.0.0", - "https-proxy-agent": "^5.0.0", - "is-lambda": "^1.0.1", - "lru-cache": "^7.7.1", - "minipass": "^5.0.0", - "minipass-fetch": "^3.0.0", - "minipass-flush": "^1.0.5", - "minipass-pipeline": "^1.2.4", - "negotiator": "^0.6.3", - "promise-retry": "^2.0.1", - "socks-proxy-agent": "^7.0.0", - "ssri": "^10.0.0" - }, - "dependencies": { - "lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true - } - } - }, "makeerror": { "version": "1.0.12", "resolved": "https://registry.npmjs.org/makeerror/-/makeerror-1.0.12.tgz", @@ -24285,7 +20444,8 @@ "merge2": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==" + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true }, "methods": { "version": "1.1.2", @@ -24293,11 +20453,11 @@ "integrity": "sha1-VSmk1nZUE07cxSZmVoNbD4Ua/O4=" }, "micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "requires": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" } }, @@ -24326,10 +20486,10 @@ "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", "dev": true }, - "mimic-response": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz", - "integrity": "sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==", + "mimic-function": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/mimic-function/-/mimic-function-5.0.1.tgz", + "integrity": "sha512-VP79XUPxV2CigYP3jWwAUFSku2aKqBH7uTAapFWCBqutsbmDo96KY5o8uh6U+/YSIn5OxJnXp73beVkpqMIGhA==", "dev": true }, "min-indent": { @@ -24364,154 +20524,6 @@ "kind-of": "^6.0.3" } }, - "minipass": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-5.0.0.tgz", - "integrity": "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ==", - "dev": true - }, - "minipass-collect": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/minipass-collect/-/minipass-collect-1.0.2.tgz", - "integrity": "sha512-6T6lH0H8OG9kITm/Jm6tdooIbogG9e0tLgpY6mphXSm/A9u8Nq1ryBG+Qspiub9LjWlBPsPS3tWQ/Botq4FdxA==", - "dev": true, - "requires": { - "minipass": "^3.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - }, - "minipass-fetch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minipass-fetch/-/minipass-fetch-3.0.4.tgz", - "integrity": "sha512-jHAqnA728uUpIaFm7NWsCnqKT6UqZz7GcI/bDpPATuwYyKwJwW0remxSCxUlKiEty+eopHGa3oc8WxgQ1FFJqg==", - "dev": true, - "requires": { - "encoding": "^0.1.13", - "minipass": "^7.0.3", - "minipass-sized": "^1.0.3", - "minizlib": "^2.1.2" - }, - "dependencies": { - "minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true - } - } - }, - "minipass-flush": { - "version": "1.0.5", - "resolved": "https://registry.npmjs.org/minipass-flush/-/minipass-flush-1.0.5.tgz", - "integrity": "sha512-JmQSYYpPUqX5Jyn1mXaRwOda1uQ8HP5KAT/oDSLCzt1BYRhQU0/hDtsB1ufZfEEzMZ9aAVmsBw8+FWsIXlClWw==", - "dev": true, - "requires": { - "minipass": "^3.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - }, - "minipass-json-stream": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/minipass-json-stream/-/minipass-json-stream-1.0.1.tgz", - "integrity": "sha512-ODqY18UZt/I8k+b7rl2AENgbWE8IDYam+undIJONvigAz8KR5GWblsFTEfQs0WODsjbSXWlm+JHEv8Gr6Tfdbg==", - "dev": true, - "requires": { - "jsonparse": "^1.3.1", - "minipass": "^3.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - }, - "minipass-pipeline": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/minipass-pipeline/-/minipass-pipeline-1.2.4.tgz", - "integrity": "sha512-xuIq7cIOt09RPRJ19gdi4b+RiNvDFYe5JH+ggNvBqGqpQXcru3PcRmOZuHBKWK1Txf9+cQ+HMVN4d6z46LZP7A==", - "dev": true, - "requires": { - "minipass": "^3.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - }, - "minipass-sized": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/minipass-sized/-/minipass-sized-1.0.3.tgz", - "integrity": "sha512-MbkQQ2CTiBMlA2Dm/5cY+9SWFEN8pzzOXi6rlM5Xxq0Yqbda5ZQy9sU75a673FE9ZK0Zsbr6Y5iP6u9nktfg2g==", - "dev": true, - "requires": { - "minipass": "^3.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - }, - "minizlib": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz", - "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==", - "dev": true, - "requires": { - "minipass": "^3.0.0", - "yallist": "^4.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - }, "mitt": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/mitt/-/mitt-1.2.0.tgz", @@ -24553,9 +20565,9 @@ "dev": true }, "ms": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", - "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==" + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" }, "nanoid": { "version": "3.3.7", @@ -24603,25 +20615,6 @@ "http2-client": "^1.2.5" } }, - "node-gyp": { - "version": "9.4.0", - "resolved": "https://registry.npmjs.org/node-gyp/-/node-gyp-9.4.0.tgz", - "integrity": "sha512-dMXsYP6gc9rRbejLXmTbVRYjAHw7ppswsKyMxuxJxxOHzluIO1rGp9TOQgjFJ+2MCqcOcQTOPB/8Xwhr+7s4Eg==", - "dev": true, - "requires": { - "env-paths": "^2.2.0", - "exponential-backoff": "^3.1.1", - "glob": "^7.1.4", - "graceful-fs": "^4.2.6", - "make-fetch-happen": "^11.0.3", - "nopt": "^6.0.0", - "npmlog": "^6.0.0", - "rimraf": "^3.0.2", - "semver": "^7.3.5", - "tar": "^6.1.2", - "which": "^2.0.2" - } - }, "node-int64": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/node-int64/-/node-int64-0.4.0.tgz", @@ -24643,15 +20636,6 @@ "integrity": "sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg==", "dev": true }, - "nopt": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/nopt/-/nopt-6.0.0.tgz", - "integrity": "sha512-ZwLpbTgdhuZUnZzjd7nb1ZV+4DoiC6/sfiVKok72ym/4Tlf+DFdlHYmT2JPmcNNWV6Pi3SDf1kT+A4r9RTuT9g==", - "dev": true, - "requires": { - "abbrev": "^1.0.0" - } - }, "normalize-package-data": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-3.0.3.tgz", @@ -24670,248 +20654,12 @@ "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", "dev": true }, - "normalize-url": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz", - "integrity": "sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==", - "dev": true - }, - "npm-bundled": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/npm-bundled/-/npm-bundled-3.0.0.tgz", - "integrity": "sha512-Vq0eyEQy+elFpzsKjMss9kxqb9tG3YHg4dsyWuUENuzvSUWe1TCnW/vV9FkhvBk/brEDoDiVd+M1Btosa6ImdQ==", - "dev": true, - "requires": { - "npm-normalize-package-bin": "^3.0.0" - } - }, "npm-check-updates": { - "version": "16.14.20", - "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-16.14.20.tgz", - "integrity": "sha512-sYbIhun4DrjO7NFOTdvs11nCar0etEhZTsEjL47eM0TuiGMhmYughRCxG2SpGRmGAQ7AkwN7bw2lWzoE7q6yOQ==", - "dev": true, - "requires": { - "@types/semver-utils": "^1.1.1", - "chalk": "^5.3.0", - "cli-table3": "^0.6.3", - "commander": "^10.0.1", - "fast-memoize": "^2.5.2", - "find-up": "5.0.0", - "fp-and-or": "^0.1.4", - "get-stdin": "^8.0.0", - "globby": "^11.0.4", - "hosted-git-info": "^5.1.0", - "ini": "^4.1.1", - "js-yaml": "^4.1.0", - "json-parse-helpfulerror": "^1.0.3", - "jsonlines": "^0.1.1", - "lodash": "^4.17.21", - "make-fetch-happen": "^11.1.1", - "minimatch": "^9.0.3", - "p-map": "^4.0.0", - "pacote": "15.2.0", - "parse-github-url": "^1.0.2", - "progress": "^2.0.3", - "prompts-ncu": "^3.0.0", - "rc-config-loader": "^4.1.3", - "remote-git-tags": "^3.0.0", - "rimraf": "^5.0.5", - "semver": "^7.5.4", - "semver-utils": "^1.1.4", - "source-map-support": "^0.5.21", - "spawn-please": "^2.0.2", - "strip-ansi": "^7.1.0", - "strip-json-comments": "^5.0.1", - "untildify": "^4.0.0", - "update-notifier": "^6.0.2" - }, - "dependencies": { - "ansi-regex": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz", - "integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==", - "dev": true - }, - "brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "requires": { - "balanced-match": "^1.0.0" - } - }, - "chalk": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.3.0.tgz", - "integrity": "sha512-dLitG79d+GV1Nb/VYcCDFivJeK1hiukt9QjRNVOsUtTy1rR1YJsmpGGTZ3qJos+uw7WmWF4wUwBd9jxjocFC2w==", - "dev": true - }, - "commander": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/commander/-/commander-10.0.1.tgz", - "integrity": "sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug==", - "dev": true - }, - "glob": { - "version": "10.3.10", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.10.tgz", - "integrity": "sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g==", - "dev": true, - "requires": { - "foreground-child": "^3.1.0", - "jackspeak": "^2.3.5", - "minimatch": "^9.0.1", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0", - "path-scurry": "^1.10.1" - } - }, - "hosted-git-info": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-5.1.0.tgz", - "integrity": "sha512-Ek+QmMEqZF8XrbFdwoDjSbm7rT23pCgEMOJmz6GPk/s4yH//RQfNPArhIxbguNxROq/+5lNBwCDHMhA903Kx1Q==", - "dev": true, - "requires": { - "lru-cache": "^7.5.1" - } - }, - "ini": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.1.tgz", - "integrity": "sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==", - "dev": true - }, - "lru-cache": { - "version": "7.14.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.14.0.tgz", - "integrity": "sha512-EIRtP1GrSJny0dqb50QXRUNBxHJhcpxHC++M5tD7RYbvLLn5KVWKsbyswSSqDuU15UFi3bgTQIY8nhDMeF6aDQ==", - "dev": true - }, - "minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "requires": { - "brace-expansion": "^2.0.1" - } - }, - "rimraf": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-5.0.5.tgz", - "integrity": "sha512-CqDakW+hMe/Bz202FPEymy68P+G50RfMQK+Qo5YUqc9SPipvbGjCGKd0RSKEelbsfQuw3g5NZDSrlZZAJurH1A==", - "dev": true, - "requires": { - "glob": "^10.3.7" - } - }, - "source-map-support": { - "version": "0.5.21", - "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", - "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", - "dev": true, - "requires": { - "buffer-from": "^1.0.0", - "source-map": "^0.6.0" - } - }, - "strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "requires": { - "ansi-regex": "^6.0.1" - } - }, - "strip-json-comments": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-5.0.1.tgz", - "integrity": "sha512-0fk9zBqO67Nq5M/m45qHCJxylV/DhBlIOVExqgOMiCCrzrhU6tCibRXNqE3jwJLftzE9SNuZtYbpzcO+i9FiKw==", - "dev": true - } - } - }, - "npm-install-checks": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/npm-install-checks/-/npm-install-checks-6.2.0.tgz", - "integrity": "sha512-744wat5wAAHsxa4590mWO0tJ8PKxR8ORZsH9wGpQc3nWTzozMAgBN/XyqYw7mg3yqLM8dLwEnwSfKMmXAjF69g==", - "dev": true, - "requires": { - "semver": "^7.1.1" - } - }, - "npm-normalize-package-bin": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/npm-normalize-package-bin/-/npm-normalize-package-bin-3.0.1.tgz", - "integrity": "sha512-dMxCf+zZ+3zeQZXKxmyuCKlIDPGuv8EF940xbkC4kQVDTtqoh6rJFO+JTKSA6/Rwi0getWmtuy4Itup0AMcaDQ==", + "version": "17.1.1", + "resolved": "https://registry.npmjs.org/npm-check-updates/-/npm-check-updates-17.1.1.tgz", + "integrity": "sha512-2aqIzGAEWB7xPf0hKHTkNmUM5jHbn2S5r2/z/7dA5Ij2h/sVYAg9R/uVkaUC3VORPAfBm7pKkCWo6E9clEVQ9A==", "dev": true }, - "npm-package-arg": { - "version": "10.1.0", - "resolved": "https://registry.npmjs.org/npm-package-arg/-/npm-package-arg-10.1.0.tgz", - "integrity": "sha512-uFyyCEmgBfZTtrKk/5xDfHp6+MdrqGotX/VoOyEEl3mBwiEE5FlBaePanazJSVMPT7vKepcjYBY2ztg9A3yPIA==", - "dev": true, - "requires": { - "hosted-git-info": "^6.0.0", - "proc-log": "^3.0.0", - "semver": "^7.3.5", - "validate-npm-package-name": "^5.0.0" - }, - "dependencies": { - "hosted-git-info": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-6.1.1.tgz", - "integrity": "sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==", - "dev": true, - "requires": { - "lru-cache": "^7.5.1" - } - }, - "lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true - } - } - }, - "npm-packlist": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/npm-packlist/-/npm-packlist-7.0.4.tgz", - "integrity": "sha512-d6RGEuRrNS5/N84iglPivjaJPxhDbZmlbTwTDX2IbcRHG5bZCdtysYMhwiPvcF4GisXHGn7xsxv+GQ7T/02M5Q==", - "dev": true, - "requires": { - "ignore-walk": "^6.0.0" - } - }, - "npm-pick-manifest": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/npm-pick-manifest/-/npm-pick-manifest-8.0.2.tgz", - "integrity": "sha512-1dKY+86/AIiq1tkKVD3l0WI+Gd3vkknVGAggsFeBkTvbhMQ1OND/LKkYv4JtXPKUJ8bOTCyLiqEg2P6QNdK+Gg==", - "dev": true, - "requires": { - "npm-install-checks": "^6.0.0", - "npm-normalize-package-bin": "^3.0.0", - "npm-package-arg": "^10.0.0", - "semver": "^7.3.5" - } - }, - "npm-registry-fetch": { - "version": "14.0.5", - "resolved": "https://registry.npmjs.org/npm-registry-fetch/-/npm-registry-fetch-14.0.5.tgz", - "integrity": "sha512-kIDMIo4aBm6xg7jOttupWZamsZRkAqMqwqqbVXnUqstY5+tapvv6bkH/qMR76jdgV+YljEUCyWx3hRYMrJiAgA==", - "dev": true, - "requires": { - "make-fetch-happen": "^11.0.0", - "minipass": "^5.0.0", - "minipass-fetch": "^3.0.0", - "minipass-json-stream": "^1.0.1", - "minizlib": "^2.1.2", - "npm-package-arg": "^10.0.0", - "proc-log": "^3.0.0" - } - }, "npm-run-path": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", @@ -24921,18 +20669,6 @@ "path-key": "^3.0.0" } }, - "npmlog": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/npmlog/-/npmlog-6.0.2.tgz", - "integrity": "sha512-/vBvz5Jfr9dT/aFWd0FIRf+T/Q2WBsLENygUaFUqstqsycmZAP/t5BvFJTK0viFmSUxiUKTUplWy5vt+rvKIxg==", - "dev": true, - "requires": { - "are-we-there-yet": "^3.0.0", - "console-control-strings": "^1.1.0", - "gauge": "^4.0.3", - "set-blocking": "^2.0.0" - } - }, "oas-kit-common": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz", @@ -25030,49 +20766,49 @@ "dev": true }, "object.assign": { - "version": "4.1.4", - "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.4.tgz", - "integrity": "sha512-1mxKf0e58bvyjSCtKYY4sRe9itRk3PJpquJOjeIkz885CczcI4IvJJDLPS72oowuSh+pBxUFROpX+TU++hxhZQ==", + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", + "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.1.4", + "call-bind": "^1.0.5", + "define-properties": "^1.2.1", "has-symbols": "^1.0.3", "object-keys": "^1.1.1" } }, "object.fromentries": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.7.tgz", - "integrity": "sha512-UPbPHML6sL8PI/mOqPwsH4G6iyXcCGzLin8KvEPenOZN5lpCNBZZQ+V62vdjB1mQHrmqGQt5/OJzemUA+KJmEA==", + "version": "2.0.8", + "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", + "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2", + "es-object-atoms": "^1.0.0" } }, "object.groupby": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.1.tgz", - "integrity": "sha512-HqaQtqLnp/8Bn4GL16cj+CUYbnpe1bh0TtEaWvybszDG4tgxCJuRpV8VGuvNaI1fAnI4lUJzDG55MXcOH4JZcQ==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/object.groupby/-/object.groupby-1.0.3.tgz", + "integrity": "sha512-+Lhy3TQTuzXI5hevh8sBGqbmurHbbIjAi0Z4S63nthVLmLxfbj4T54a4CfZrXIrt9iP4mVAPYMo/v99taj3wjQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1", - "get-intrinsic": "^1.2.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.2" } }, "object.values": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.1.7.tgz", - "integrity": "sha512-aU6xnDFYT3x17e/f0IiiwlGPTy2jzMySGfUB4fq6z7CV8l85CWHDk5ErhyhpfDHhrOMwGFhSQkhMGHaIotA6Ng==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.0.tgz", + "integrity": "sha512-yBYjY9QX2hnRmZHAjG/f13MzmBzxzYgQhFrke06TTyKY5zSTEqkOeukBzIdVA3j3ulu8Qa3MbVFShV7T2RmGtQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" } }, "on-finished": { @@ -25118,23 +20854,72 @@ "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==" }, "openapi-typescript": { - "version": "6.7.6", - "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-6.7.6.tgz", - "integrity": "sha512-c/hfooPx+RBIOPM09GSxABOZhYPblDoyaGhqBkD/59vtpN21jEuWKDlM0KYTvqJVlSYjKs0tBcIdeXKChlSPtw==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.4.0.tgz", + "integrity": "sha512-u4iVuTGkzKG4rHFUMA/IFXTks9tYVQzkowZsScMOdzJSvIF10qSNySWHTwnN2fD+MEeWFAM8i1f3IUBlgS92eQ==", "requires": { + "@redocly/openapi-core": "^1.16.0", "ansi-colors": "^4.1.3", - "fast-glob": "^3.3.2", - "js-yaml": "^4.1.0", + "change-case": "^5.4.4", + "parse-json": "^8.1.0", "supports-color": "^9.4.0", - "undici": "^5.28.4", "yargs-parser": "^21.1.1" }, "dependencies": { + "@redocly/openapi-core": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.22.1.tgz", + "integrity": "sha512-pjr456gJzrbwPvBjFKlWOd9nZEcr/dp6XSH0c8ijWGWv5K+V0vpUUy2zaTAVsFAoCydx1miEoOcbLhWQ9WC2nw==", + "requires": { + "@redocly/ajv": "^8.11.0", + "@redocly/config": "^0.10.1", + "colorette": "^1.2.0", + "https-proxy-agent": "^7.0.4", + "js-levenshtein": "^1.1.6", + "js-yaml": "^4.1.0", + "lodash.isequal": "^4.5.0", + "minimatch": "^5.0.1", + "node-fetch": "^2.6.1", + "pluralize": "^8.0.0", + "yaml-ast-parser": "0.0.43" + } + }, + "brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "requires": { + "balanced-match": "^1.0.0" + } + }, + "minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "requires": { + "brace-expansion": "^2.0.1" + } + }, + "parse-json": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.1.0.tgz", + "integrity": "sha512-rum1bPifK5SSar35Z6EKZuYPJx85pkNaFrxBK3mwdfSJ1/WKbYrjoW/zTPSjRRamfmVX1ACBIdFAO0VRErW/EA==", + "requires": { + "@babel/code-frame": "^7.22.13", + "index-to-position": "^0.1.2", + "type-fest": "^4.7.1" + } + }, "supports-color": { "version": "9.4.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-9.4.0.tgz", "integrity": "sha512-VL+lNrEoIXww1coLPOmiEmK/0sGigko5COxI09KzHc2VJXJsQ37UaQ+8quuxjDeA7+KnLGTWRyOXSLLR2Wb4jw==" }, + "type-fest": { + "version": "4.26.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.26.0.tgz", + "integrity": "sha512-OduNjVJsFbifKb57UqZ2EMP1i4u64Xwow3NYXUtBbD4vIwJdQd4+xl8YDou1dlm4DVrtwT/7Ky8z8WyCULVfxw==" + }, "yargs-parser": { "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", @@ -25173,12 +20958,6 @@ "type-check": "^0.4.0" } }, - "p-cancelable": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-3.0.0.tgz", - "integrity": "sha512-mlVgR3PGuzlo0MmTdk4cXqXWlwQDLnONTAg6sm62XkMJEiRxN3GL3SffkYvqwonbkJBcrI7Uvv5Zh9yjvn2iUw==", - "dev": true - }, "p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", @@ -25197,59 +20976,12 @@ "p-limit": "^3.0.2" } }, - "p-map": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/p-map/-/p-map-4.0.0.tgz", - "integrity": "sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==", - "dev": true, - "requires": { - "aggregate-error": "^3.0.0" - } - }, "p-try": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", "dev": true }, - "package-json": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-8.1.0.tgz", - "integrity": "sha512-hySwcV8RAWeAfPsXb9/HGSPn8lwDnv6fabH+obUZKX169QknRkRhPxd1yMubpKDskLFATkl3jHpNtVtDPFA0Wg==", - "dev": true, - "requires": { - "got": "^12.1.0", - "registry-auth-token": "^5.0.1", - "registry-url": "^6.0.0", - "semver": "^7.3.7" - } - }, - "pacote": { - "version": "15.2.0", - "resolved": "https://registry.npmjs.org/pacote/-/pacote-15.2.0.tgz", - "integrity": "sha512-rJVZeIwHTUta23sIZgEIM62WYwbmGbThdbnkt81ravBplQv+HjyroqnLRNH2+sLJHcGZmLRmhPwACqhfTcOmnA==", - "dev": true, - "requires": { - "@npmcli/git": "^4.0.0", - "@npmcli/installed-package-contents": "^2.0.1", - "@npmcli/promise-spawn": "^6.0.1", - "@npmcli/run-script": "^6.0.0", - "cacache": "^17.0.0", - "fs-minipass": "^3.0.0", - "minipass": "^5.0.0", - "npm-package-arg": "^10.0.0", - "npm-packlist": "^7.0.0", - "npm-pick-manifest": "^8.0.0", - "npm-registry-fetch": "^14.0.0", - "proc-log": "^3.0.0", - "promise-retry": "^2.0.1", - "read-package-json": "^6.0.0", - "read-package-json-fast": "^3.0.0", - "sigstore": "^1.3.0", - "ssri": "^10.0.0", - "tar": "^6.1.11" - } - }, "parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -25259,12 +20991,6 @@ "callsites": "^3.0.0" } }, - "parse-github-url": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/parse-github-url/-/parse-github-url-1.0.2.tgz", - "integrity": "sha512-kgBf6avCbO3Cn6+RnzRGLkUsv4ZVqv/VfAYkRsyBcgkshNvVBkRn1FEZcW0Jb+npXQWm2vHPnnOqFteZxRRGNw==", - "dev": true - }, "parse-json": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", @@ -25322,30 +21048,6 @@ "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", "dev": true }, - "path-scurry": { - "version": "1.10.1", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz", - "integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==", - "dev": true, - "requires": { - "lru-cache": "^9.1.1 || ^10.0.0", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" - }, - "dependencies": { - "lru-cache": { - "version": "10.0.1", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.0.1.tgz", - "integrity": "sha512-IJ4uwUTi2qCccrioU6g9g/5rvvVl13bsdczUUcqbciD9iLr095yj8DQKdObriEvuNSx325N1rV1O0sJFszx75g==", - "dev": true - } - } - }, - "path-type": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", - "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", - "dev": true - }, "pause-stream": { "version": "0.0.11", "resolved": "https://registry.npmjs.org/pause-stream/-/pause-stream-0.0.11.tgz", @@ -25493,6 +21195,12 @@ "is-number-like": "^1.0.3" } }, + "possible-typed-array-names": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", + "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", + "dev": true + }, "postcss": { "version": "8.4.32", "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.4.32.tgz", @@ -25517,9 +21225,9 @@ "dev": true }, "prettier": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.0.tgz", - "integrity": "sha512-J9odKxERhCQ10OC2yb93583f6UnYutOeiV5i0zEDS7UGTdUt0u+y8erxl3lBKvwo/JHyyoEdXjwp4dke9oyZ/g==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz", + "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==", "dev": true }, "prettier-linter-helpers": { @@ -25556,39 +21264,11 @@ "integrity": "sha512-Kx/1w86q/epKcmte75LNrEoT+lX8pBpavuAbvJWRXar7Hz8jrtF+e3vY751p0R8H9HdArwaCTNDDzHg/ScJK1Q==", "dev": true }, - "proc-log": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/proc-log/-/proc-log-3.0.0.tgz", - "integrity": "sha512-++Vn7NS4Xf9NacaU9Xq3URUuqZETPsf8L4j5/ckhaRYsfPeRyzGw+iDjFhV/Jr3uNmTvvddEJFWh5R1gRgUH8A==", - "dev": true - }, "process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==" }, - "progress": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", - "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", - "dev": true - }, - "promise-inflight": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/promise-inflight/-/promise-inflight-1.0.1.tgz", - "integrity": "sha512-6zWPyEOFaQBJYcGMHBKTKJ3u6TBsnMFOIZSa6ce1e/ZrrsOlnHRHbabMjLiBYKp+n44X9eUI6VUPaukCXHuG4g==", - "dev": true - }, - "promise-retry": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz", - "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==", - "dev": true, - "requires": { - "err-code": "^2.0.2", - "retry": "^0.12.0" - } - }, "prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -25599,24 +21279,6 @@ "sisteransi": "^1.0.5" } }, - "prompts-ncu": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/prompts-ncu/-/prompts-ncu-3.0.0.tgz", - "integrity": "sha512-qyz9UxZ5MlPKWVhWrCmSZ1ahm2GVYdjLb8og2sg0IPth1KRuhcggHGuijz0e41dkx35p1t1q3GRISGH7QGALFA==", - "dev": true, - "requires": { - "kleur": "^4.0.1", - "sisteransi": "^1.0.5" - }, - "dependencies": { - "kleur": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", - "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", - "dev": true - } - } - }, "prop-types": { "version": "15.8.1", "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", @@ -25636,36 +21298,11 @@ } } }, - "proto-list": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", - "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", - "dev": true - }, - "pump": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.0.tgz", - "integrity": "sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==", - "dev": true, - "requires": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } - }, "punycode": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" }, - "pupa": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.1.0.tgz", - "integrity": "sha512-FLpr4flz5xZTSJxSeaheeMKN/EDzMdK7b8PTOC6a5PYFKTucWbdqjgqaEyH0shFiSJrVB1+Qqi4Tk19ccU6Aug==", - "dev": true, - "requires": { - "escape-goat": "^4.0.0" - } - }, "pure-rand": { "version": "6.0.3", "resolved": "https://registry.npmjs.org/pure-rand/-/pure-rand-6.0.3.tgz", @@ -25689,7 +21326,8 @@ "queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==" + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true }, "quick-lru": { "version": "4.0.1", @@ -25735,38 +21373,6 @@ } } }, - "rc": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", - "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", - "dev": true, - "requires": { - "deep-extend": "^0.6.0", - "ini": "~1.3.0", - "minimist": "^1.2.0", - "strip-json-comments": "~2.0.1" - }, - "dependencies": { - "strip-json-comments": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", - "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", - "dev": true - } - } - }, - "rc-config-loader": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/rc-config-loader/-/rc-config-loader-4.1.3.tgz", - "integrity": "sha512-kD7FqML7l800i6pS6pvLyIE2ncbk9Du8Q0gp/4hMPhJU6ZxApkoLcGD8ZeqgiAlfwZ6BlETq6qqe+12DUL207w==", - "dev": true, - "requires": { - "debug": "^4.3.4", - "js-yaml": "^4.1.0", - "json5": "^2.2.2", - "require-from-string": "^2.0.2" - } - }, "react": { "version": "18.2.0", "resolved": "https://registry.npmjs.org/react/-/react-18.2.0.tgz", @@ -25802,102 +21408,6 @@ "prop-types": "^15.5.0" } }, - "read-package-json": { - "version": "6.0.4", - "resolved": "https://registry.npmjs.org/read-package-json/-/read-package-json-6.0.4.tgz", - "integrity": "sha512-AEtWXYfopBj2z5N5PbkAOeNHRPUg5q+Nen7QLxV8M2zJq1ym6/lCz3fYNTCXe19puu2d06jfHhrP7v/S2PtMMw==", - "dev": true, - "requires": { - "glob": "^10.2.2", - "json-parse-even-better-errors": "^3.0.0", - "normalize-package-data": "^5.0.0", - "npm-normalize-package-bin": "^3.0.0" - }, - "dependencies": { - "brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "requires": { - "balanced-match": "^1.0.0" - } - }, - "glob": { - "version": "10.3.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.3.3.tgz", - "integrity": "sha512-92vPiMb/iqpmEgsOoIDvTjc50wf9CCCvMzsi6W0JLPeUKE8TWP1a73PgqSrqy7iAZxaSD1YdzU7QZR5LF51MJw==", - "dev": true, - "requires": { - "foreground-child": "^3.1.0", - "jackspeak": "^2.0.3", - "minimatch": "^9.0.1", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0", - "path-scurry": "^1.10.1" - } - }, - "hosted-git-info": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-6.1.1.tgz", - "integrity": "sha512-r0EI+HBMcXadMrugk0GCQ+6BQV39PiWAZVfq7oIckeGiN7sjRGyQxPdft3nQekFTCQbYxLBH+/axZMeH8UX6+w==", - "dev": true, - "requires": { - "lru-cache": "^7.5.1" - } - }, - "json-parse-even-better-errors": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.0.tgz", - "integrity": "sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==", - "dev": true - }, - "lru-cache": { - "version": "7.18.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz", - "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==", - "dev": true - }, - "minimatch": { - "version": "9.0.3", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", - "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", - "dev": true, - "requires": { - "brace-expansion": "^2.0.1" - } - }, - "normalize-package-data": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-5.0.0.tgz", - "integrity": "sha512-h9iPVIfrVZ9wVYQnxFgtw1ugSvGEMOlyPWWtm8BMJhnwyEL/FLbYbTY3V3PpjI/BUK67n9PEWDu6eHzu1fB15Q==", - "dev": true, - "requires": { - "hosted-git-info": "^6.0.0", - "is-core-module": "^2.8.1", - "semver": "^7.3.5", - "validate-npm-package-license": "^3.0.4" - } - } - } - }, - "read-package-json-fast": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/read-package-json-fast/-/read-package-json-fast-3.0.2.tgz", - "integrity": "sha512-0J+Msgym3vrLOUB3hzQCuZHII0xkNGCtz/HJH9xZshwv9DbDwkw1KaE3gx/e2J5rpEY5rtOy6cyhKOPrkP7FZw==", - "dev": true, - "requires": { - "json-parse-even-better-errors": "^3.0.0", - "npm-normalize-package-bin": "^3.0.0" - }, - "dependencies": { - "json-parse-even-better-errors": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-3.0.0.tgz", - "integrity": "sha512-iZbGHafX/59r39gPwVPRBGw0QQKnA7tte5pSMrhWOW7swGsVvVTjmfyAV9pNqk8YGT7tRCdxRu8uzcgZwoDooA==", - "dev": true - } - } - }, "read-pkg": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz", @@ -26084,14 +21594,15 @@ "dev": true }, "regexp.prototype.flags": { - "version": "1.5.1", - "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.1.tgz", - "integrity": "sha512-sy6TXMN+hnP/wMy+ISxg3krXx7BAtWVO4UouuCN/ziM9UEne0euamVNafDfvC83bRNr95y0V5iijeDQFUNpvrg==", + "version": "1.5.2", + "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", + "integrity": "sha512-NcDiDkTLuPR+++OCKB0nWafEmhg/Da8aUPLPMQbK+bxKKCm1/S5he+AqYa4PlMCVBalb4/yxIRub6qkEx5yJbw==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "set-function-name": "^2.0.0" + "call-bind": "^1.0.6", + "define-properties": "^1.2.1", + "es-errors": "^1.3.0", + "set-function-name": "^2.0.1" } }, "regexpp": { @@ -26100,30 +21611,6 @@ "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", "dev": true }, - "registry-auth-token": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.0.1.tgz", - "integrity": "sha512-UfxVOj8seK1yaIOiieV4FIP01vfBDLsY0H9sQzi9EbbUdJiuuBjJgLa1DpImXMNPnVkBD4eVxTEXcrZA6kfpJA==", - "dev": true, - "requires": { - "@pnpm/npm-conf": "^1.0.4" - } - }, - "registry-url": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", - "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", - "dev": true, - "requires": { - "rc": "1.2.8" - } - }, - "remote-git-tags": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/remote-git-tags/-/remote-git-tags-3.0.0.tgz", - "integrity": "sha512-C9hAO4eoEsX+OXA4rla66pXZQ+TLQ8T9dttgQj18yuKlPMTVkIkdYXvlMC55IuUsIkV6DpmQYi10JKFLaU+l7w==", - "dev": true - }, "require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -26158,12 +21645,6 @@ "supports-preserve-symlinks-flag": "^1.0.0" } }, - "resolve-alpn": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/resolve-alpn/-/resolve-alpn-1.2.1.tgz", - "integrity": "sha512-0a1F4l73/ZFZOakJnQ3FvkJ2+gSTQWz/r2KE5OdDY0TxPm5h4GkqkWWfM47T7HsbnOtcJVEF4epCVy6u7Q3K+g==", - "dev": true - }, "resolve-cwd": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", @@ -26179,6 +21660,12 @@ "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", "dev": true }, + "resolve-pkg-maps": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/resolve-pkg-maps/-/resolve-pkg-maps-1.0.0.tgz", + "integrity": "sha512-seS2Tj26TBVOC2NIc2rOe2y2ZO7efxITtLZcGSOnHHNOQ7CkiUBfw0Iw2ck6xkIhPwLhKNLS8BO+hEpngQlqzw==", + "dev": true + }, "resolve.exports": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/resolve.exports/-/resolve.exports-2.0.2.tgz", @@ -26212,48 +21699,43 @@ } } }, - "responselike": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-2.0.0.tgz", - "integrity": "sha512-xH48u3FTB9VsZw7R+vvgaKeLKzT6jOogbQhEe/jewwnZgzPcnyWui2Av6JpoYZF/91uueC+lqhWqeURw5/qhCw==", + "restore-cursor": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-5.1.0.tgz", + "integrity": "sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA==", "dev": true, "requires": { - "lowercase-keys": "^2.0.0" + "onetime": "^7.0.0", + "signal-exit": "^4.1.0" }, "dependencies": { - "lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", + "onetime": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/onetime/-/onetime-7.0.0.tgz", + "integrity": "sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==", + "dev": true, + "requires": { + "mimic-function": "^5.0.0" + } + }, + "signal-exit": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", + "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", "dev": true } } }, - "restore-cursor": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-4.0.0.tgz", - "integrity": "sha512-I9fPXU9geO9bHOt9pHHOhOkYerIMsmVaWB0rA2AI9ERh/+x/i7MV5HKBNrg+ljO5eoPVgCcnFuRjJ9uH6I/3eg==", - "dev": true, - "requires": { - "onetime": "^5.1.0", - "signal-exit": "^3.0.2" - } - }, - "retry": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz", - "integrity": "sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==", - "dev": true - }, "reusify": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==" + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true }, "rfdc": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.3.1.tgz", - "integrity": "sha512-r5a3l5HzYlIC68TpmYKlxWjmOP6wiPJ1vWv2HeLhNsRZMrCkxeqxiHlQ21oXmQ4F3SiryXBHhAD7JZqvOJjFmg==", + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/rfdc/-/rfdc-1.4.1.tgz", + "integrity": "sha512-q1b3N5QkRUWUl7iyylaaj3kOpIT0N2i9MqIEQXP73GVsN9cw3fdx8X63cEmWhJGi2PPCF23Ijp7ktmd39rawIA==", "dev": true }, "rimraf": { @@ -26269,6 +21751,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, "requires": { "queue-microtask": "^1.2.2" } @@ -26280,13 +21763,13 @@ "dev": true }, "safe-array-concat": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.0.1.tgz", - "integrity": "sha512-6XbUAseYE2KtOuGueyeobCySj9L4+66Tn6KQMOPQJrAJEowYKW/YR/MGJZl7FdydUdaFu4LYyDZjxf4/Nmo23Q==", + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.2.tgz", + "integrity": "sha512-vj6RsCsWBCf19jIeHEfkRMw8DPiBb+DMXklQ/1SGDHOMlHdPUkZXFQ2YdplS23zESTijAcurb1aSgJA3AgMu1Q==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.1", + "call-bind": "^1.0.7", + "get-intrinsic": "^1.2.4", "has-symbols": "^1.0.3", "isarray": "^2.0.5" }, @@ -26305,13 +21788,13 @@ "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==" }, "safe-regex-test": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.0.tgz", - "integrity": "sha512-JBUUzyOgEwXQY1NuPtvcj/qcBDbDmEvWufhlnXZIm75DEHp+afM1r1ujJpJsV/gSM4t59tpDyPi1sd6ZaPFfsA==", + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.0.3.tgz", + "integrity": "sha512-CdASjNJPvRa7roO6Ra/gLYBTzYzzPyyBXxIMdGW3USQLyjWEls2RgW5UBTXaQVp+OrpeCK3bLem8smtmheoRuw==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.3", + "call-bind": "^1.0.6", + "es-errors": "^1.3.0", "is-regex": "^1.1.4" } }, @@ -26321,34 +21804,19 @@ "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", "devOptional": true }, - "scheduler": { - "version": "0.23.0", - "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.0.tgz", - "integrity": "sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==", - "dev": true, - "requires": { - "loose-envify": "^1.1.0" - } - }, - "semver": { - "version": "7.6.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz", - "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==", - "dev": true - }, - "semver-diff": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-4.0.0.tgz", - "integrity": "sha512-0Ju4+6A8iOnpL/Thra7dZsSlOHYAHIeMxfhWQRI1/VLcT3WDBZKKtQt/QkBOsiIN9ZpuvHE6cGZ0x4glCMmfiA==", + "scheduler": { + "version": "0.23.0", + "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.23.0.tgz", + "integrity": "sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==", "dev": true, "requires": { - "semver": "^7.3.5" + "loose-envify": "^1.1.0" } }, - "semver-utils": { - "version": "1.1.4", - "resolved": "https://registry.npmjs.org/semver-utils/-/semver-utils-1.1.4.tgz", - "integrity": "sha512-EjnoLE5OGmDAVV/8YDoN5KiajNadjzIp9BAHOhYeQHt7j0UWxjmgsx4YD48wp4Ue1Qogq38F1GNUJNqF1kKKxA==", + "semver": { + "version": "7.6.3", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz", + "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==", "dev": true }, "send": { @@ -26518,25 +21986,28 @@ "dev": true }, "set-function-length": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.1.1.tgz", - "integrity": "sha512-VoaqjbBJKiWtg4yRcKBQ7g7wnGnLV3M8oLvVWwOk2PdYY6PEFegR1vezXR0tw6fZGF9csVakIRjrJiy2veSBFQ==", + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", "requires": { - "define-data-property": "^1.1.1", - "get-intrinsic": "^1.2.1", + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", "gopd": "^1.0.1", - "has-property-descriptors": "^1.0.0" + "has-property-descriptors": "^1.0.2" } }, "set-function-name": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.1.tgz", - "integrity": "sha512-tMNCiqYVkXIZgc2Hnoy2IvC/f8ezc5koaRFkCjrpWzGpCd3qbZXPzVy9MAZzK1ch/X0jvSkojys3oqJN0qCmdA==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", + "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", "dev": true, "requires": { - "define-data-property": "^1.0.1", + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", "functions-have-names": "^1.2.3", - "has-property-descriptors": "^1.0.0" + "has-property-descriptors": "^1.0.2" } }, "setprototypeof": { @@ -26636,19 +22107,6 @@ "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", "dev": true }, - "sigstore": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/sigstore/-/sigstore-1.9.0.tgz", - "integrity": "sha512-0Zjz0oe37d08VeOtBIuB6cRriqXse2e8w+7yIy2XSXjshRKxbc2KkhXjL229jXSxEm7UbcjS76wcJDGQddVI9A==", - "dev": true, - "requires": { - "@sigstore/bundle": "^1.1.0", - "@sigstore/protobuf-specs": "^0.2.0", - "@sigstore/sign": "^1.0.0", - "@sigstore/tuf": "^1.0.3", - "make-fetch-happen": "^11.0.1" - } - }, "simple-websocket": { "version": "9.1.0", "resolved": "https://registry.npmjs.org/simple-websocket/-/simple-websocket-9.1.0.tgz", @@ -26697,12 +22155,6 @@ "integrity": "sha512-tf+h5W1IrjNm/9rKKj0JU2MDMruiopx0jjVA5zCdBtcGjfp0+c5rHw/zADLC3IeKlGHtVbHtpfzvYA0OYT+HKg==", "dev": true }, - "smart-buffer": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz", - "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==", - "dev": true - }, "socket.io": { "version": "4.7.2", "resolved": "https://registry.npmjs.org/socket.io/-/socket.io-4.7.2.tgz", @@ -26758,27 +22210,6 @@ "debug": "~4.3.1" } }, - "socks": { - "version": "2.8.3", - "resolved": "https://registry.npmjs.org/socks/-/socks-2.8.3.tgz", - "integrity": "sha512-l5x7VUUWbjVFbafGLxPWkYsHIhEvmF85tbIeFZWc8ZPtoMyybuEhL7Jye/ooC4/d48FgOjSJXgsF/AJPYCW8Zw==", - "dev": true, - "requires": { - "ip-address": "^9.0.5", - "smart-buffer": "^4.2.0" - } - }, - "socks-proxy-agent": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-7.0.0.tgz", - "integrity": "sha512-Fgl0YPZ902wEsAyiQ+idGd1A7rSFx/ayC1CQVMw5P+EQx2V0SgpGtf6OKFhVjPflPUl9YMmEOnmfjCdMUsygww==", - "dev": true, - "requires": { - "agent-base": "^6.0.2", - "debug": "^4.3.3", - "socks": "^2.6.2" - } - }, "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -26801,15 +22232,6 @@ "source-map": "^0.6.0" } }, - "spawn-please": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/spawn-please/-/spawn-please-2.0.2.tgz", - "integrity": "sha512-KM8coezO6ISQ89c1BzyWNtcn2V2kAVtwIXd3cN/V5a0xPYc1F/vydrRc01wsKFEQ/p+V1a4sw4z2yMITIXrgGw==", - "dev": true, - "requires": { - "cross-spawn": "^7.0.3" - } - }, "spdx-correct": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", @@ -26865,23 +22287,6 @@ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" }, - "ssri": { - "version": "10.0.5", - "resolved": "https://registry.npmjs.org/ssri/-/ssri-10.0.5.tgz", - "integrity": "sha512-bSf16tAFkGeRlUNDjXu8FzaMQt6g2HZJrun7mtMbIPOddxt3GLMSz5VWUWcqTJUPfLEaDIepGxv+bYQW49596A==", - "dev": true, - "requires": { - "minipass": "^7.0.3" - }, - "dependencies": { - "minipass": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.3.tgz", - "integrity": "sha512-LhbbwCfz3vsb12j/WkWQPZfKTsgqIe1Nf/ti1pKjYESGLHIVjWU96G9/ljLH4F9mWNVhlQOm0VySdAWzf05dpg==", - "dev": true - } - } - }, "stack-utils": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/stack-utils/-/stack-utils-2.0.5.tgz", @@ -27091,14 +22496,14 @@ } }, "string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", "dev": true, "requires": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" }, "dependencies": { "ansi-regex": { @@ -27108,9 +22513,9 @@ "dev": true }, "strip-ansi": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.0.1.tgz", - "integrity": "sha512-cXNxvT8dFNRVfhVME3JAe98mkXDYN2O1l7jmcwMnOslDeESg1rF/OZMtK0nRAhiari1unG5cD4jG3rapUAkLbw==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", + "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", "dev": true, "requires": { "ansi-regex": "^6.0.1" @@ -27118,62 +22523,38 @@ } } }, - "string-width-cjs": { - "version": "npm:string-width@4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "dependencies": { - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - } - } - }, "string.prototype.trim": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.8.tgz", - "integrity": "sha512-lfjY4HcixfQXOfaqCvcBuOIapyaroTXhbkfJN3gcB1OtyupngWK4sEET9Knd0cXd28kTUqu/kHoV4HKSJdnjiQ==", + "version": "1.2.9", + "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.9.tgz", + "integrity": "sha512-klHuCNxiMZ8MlsOihJhJEBJAiMVqU3Z2nEXWfWnIqjN0gEFS9J9+IxKozWWtQGcgoa1WUZzLjKPTr4ZHNFTFxw==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-abstract": "^1.23.0", + "es-object-atoms": "^1.0.0" } }, "string.prototype.trimend": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.7.tgz", - "integrity": "sha512-Ni79DqeB72ZFq1uH/L6zJ+DKZTkOtPIHovb3YZHQViE+HDouuU4mBrLOLDn5Dde3RF8qw5qVETEjhu9locMLvA==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.8.tgz", + "integrity": "sha512-p73uL5VCHCO2BZZ6krwwQE3kCzM7NKmis8S//xEC6fQonchbum4eP6kR4DLEjQFO3Wnj3Fuo8NM0kOSjVdHjZQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" } }, "string.prototype.trimstart": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.7.tgz", - "integrity": "sha512-NGhtDFu3jCEm7B4Fy0DpLewdJQOZcQ0rGbwQ/+stjnrp2i+rlKeCvos9hOIeCmqwratM47OBxY7uFZzjxHXmrg==", + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", + "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "define-properties": "^1.2.0", - "es-abstract": "^1.22.1" + "call-bind": "^1.0.7", + "define-properties": "^1.2.1", + "es-object-atoms": "^1.0.0" } }, "stringify-package": { @@ -27191,15 +22572,6 @@ "ansi-regex": "^5.0.1" } }, - "strip-ansi-cjs": { - "version": "npm:strip-ansi@6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, - "requires": { - "ansi-regex": "^5.0.1" - } - }, "strip-bom": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-4.0.0.tgz", @@ -27356,9 +22728,9 @@ } }, "synckit": { - "version": "0.8.8", - "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.8.8.tgz", - "integrity": "sha512-HwOKAP7Wc5aRGYdKH+dw0PRRpbO841v2DENBtjnR5HFWoiNByAl7vrx3p0G/rCyYXQsrxqtX48TImFtPcIHSpQ==", + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/synckit/-/synckit-0.9.1.tgz", + "integrity": "sha512-7gr8p9TQP6RAHusBOSLs46F4564ZrjV8xFmw5zCmgmhGUcw2hxsShhJ6CEiHQMgPDwAQ1fWHPM0ypc4RMAig4A==", "dev": true, "requires": { "@pkgr/core": "^0.1.0", @@ -27371,42 +22743,6 @@ "integrity": "sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==", "dev": true }, - "tar": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/tar/-/tar-6.2.1.tgz", - "integrity": "sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A==", - "dev": true, - "requires": { - "chownr": "^2.0.0", - "fs-minipass": "^2.0.0", - "minipass": "^5.0.0", - "minizlib": "^2.1.1", - "mkdirp": "^1.0.3", - "yallist": "^4.0.0" - }, - "dependencies": { - "fs-minipass": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/fs-minipass/-/fs-minipass-2.1.0.tgz", - "integrity": "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg==", - "dev": true, - "requires": { - "minipass": "^3.0.0" - }, - "dependencies": { - "minipass": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz", - "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - } - } - } - } - }, "test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -27490,34 +22826,35 @@ "requires": {} }, "ts-auto-mock": { - "version": "3.7.3", - "resolved": "https://registry.npmjs.org/ts-auto-mock/-/ts-auto-mock-3.7.3.tgz", - "integrity": "sha512-EmFVlfQQWogVtWWgkDXVdtLgGje0P8PaWFz217A4ojNIMwF+iKFnim6ykZsGAtClWCfmGig0VMH7KlbMxc8yKw==", + "version": "3.7.4", + "resolved": "https://registry.npmjs.org/ts-auto-mock/-/ts-auto-mock-3.7.4.tgz", + "integrity": "sha512-+/X+7yjpUBsIJBRxl/hs9aq3pA76w3Pcu70uHDxdr4C8TbXXwd/gq6t3b81xqU9N/KPFIFata1HcQZ2lwGKDRQ==", "requires": { "lodash-es": "4.17.21", - "micromatch": "4.0.5" + "micromatch": "4.0.8" } }, "ts-jest": { - "version": "29.1.4", - "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.1.4.tgz", - "integrity": "sha512-YiHwDhSvCiItoAgsKtoLFCuakDzDsJ1DLDnSouTaTmdOcOwIkSzbLXduaQ6M5DRVhuZC/NYaaZ/mtHbWMv/S6Q==", + "version": "29.2.5", + "resolved": "https://registry.npmjs.org/ts-jest/-/ts-jest-29.2.5.tgz", + "integrity": "sha512-KD8zB2aAZrcKIdGk4OwpJggeLcH1FgrICqDSROWqlnJXGCXK4Mn6FcdK2B6670Xr73lHMG1kHw8R87A0ecZ+vA==", "dev": true, "requires": { - "bs-logger": "0.x", - "fast-json-stable-stringify": "2.x", + "bs-logger": "^0.2.6", + "ejs": "^3.1.10", + "fast-json-stable-stringify": "^2.1.0", "jest-util": "^29.0.0", "json5": "^2.2.3", - "lodash.memoize": "4.x", - "make-error": "1.x", - "semver": "^7.5.3", - "yargs-parser": "^21.0.1" + "lodash.memoize": "^4.1.2", + "make-error": "^1.3.6", + "semver": "^7.6.3", + "yargs-parser": "^21.1.1" }, "dependencies": { "yargs-parser": { - "version": "21.0.1", - "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.0.1.tgz", - "integrity": "sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg==", + "version": "21.1.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", + "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", "dev": true } } @@ -27552,9 +22889,9 @@ } }, "ts-patch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/ts-patch/-/ts-patch-3.1.2.tgz", - "integrity": "sha512-n58F5AqjUMdp9RAKq+E1YBkmONltPVbt1nN+wrmZXoYZek6QcvaTuqvKMhYhr5BxtC53kD/exxIPA1cP1RQxsA==", + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ts-patch/-/ts-patch-3.2.1.tgz", + "integrity": "sha512-hlR43v+GUIUy8/ZGFP1DquEqPh7PFKQdDMTAmYt671kCCA6AkDQMoeFaFmZ7ObPLYOmpMgyKUqL1C+coFMf30w==", "dev": true, "requires": { "chalk": "^4.1.2", @@ -27595,22 +22932,11 @@ } }, "tslib": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.2.tgz", - "integrity": "sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==", + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.7.0.tgz", + "integrity": "sha512-gLXCKdN1/j47AiHiOkJN69hJmcbGTHI0ImLmbYLHykhgeN0jVGola9yVjFgzCUklsZQMW55o+dW7IXv3RCXDzA==", "dev": true }, - "tuf-js": { - "version": "1.1.7", - "resolved": "https://registry.npmjs.org/tuf-js/-/tuf-js-1.1.7.tgz", - "integrity": "sha512-i3P9Kgw3ytjELUfpuKVDNBJvk4u5bXL6gskv572mcevPbSKCV3zt3djhmlEQ65yERjIbOSncy7U4cQJaB1CBCg==", - "dev": true, - "requires": { - "@tufjs/models": "1.0.4", - "debug": "^4.3.4", - "make-fetch-happen": "^11.1.1" - } - }, "type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", @@ -27633,50 +22959,55 @@ "dev": true }, "typed-array-buffer": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.0.tgz", - "integrity": "sha512-Y8KTSIglk9OZEr8zywiIHG/kmQ7KWyjseXs1CbSo8vC42w7hg2HgYTxSWwP0+is7bWDc1H+Fo026CpHFwm8tkw==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.2.tgz", + "integrity": "sha512-gEymJYKZtKXzzBzM4jqa9w6Q1Jjm7x2d+sh19AdsD4wqnMPDYyvwpsIc2Q/835kHuo3BEQ7CjelGhfTsoBb2MQ==", "dev": true, "requires": { - "call-bind": "^1.0.2", - "get-intrinsic": "^1.2.1", - "is-typed-array": "^1.1.10" + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "is-typed-array": "^1.1.13" } }, "typed-array-byte-length": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.0.tgz", - "integrity": "sha512-Or/+kvLxNpeQ9DtSydonMxCx+9ZXOswtwJn17SNLvhptaXYDJvkFFP5zbfU/uLmvnBJlI4yrnXRxpdWH/M5tNA==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.1.tgz", + "integrity": "sha512-3iMJ9q0ao7WE9tWcaYKIptkNBuOIcZCCT0d4MRvuuH88fEoEH62IuQe0OtraD3ebQEoTRk8XCBoknUNc1Y67pw==", "dev": true, "requires": { - "call-bind": "^1.0.2", + "call-bind": "^1.0.7", "for-each": "^0.3.3", - "has-proto": "^1.0.1", - "is-typed-array": "^1.1.10" + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" } }, "typed-array-byte-offset": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.0.tgz", - "integrity": "sha512-RD97prjEt9EL8YgAgpOkf3O4IF9lhJFr9g0htQkm0rchFp/Vx7LW5Q8fSXXub7BXAODyUQohRMyOc3faCPd0hg==", + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.2.tgz", + "integrity": "sha512-Ous0vodHa56FviZucS2E63zkgtgrACj7omjwd/8lTEMEPFFyjfixMZ1ZXenpgCFBBt4EC1J2XsyVS2gkG0eTFA==", "dev": true, "requires": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.2", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", "for-each": "^0.3.3", - "has-proto": "^1.0.1", - "is-typed-array": "^1.1.10" + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13" } }, "typed-array-length": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.4.tgz", - "integrity": "sha512-KjZypGq+I/H7HI5HlOoGHkWUUGq+Q0TPhQurLbyrVrvnKTBgzLhIJ7j6J/XTQOi0d1RjyZ0wdas8bKs2p0x3Ng==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.6.tgz", + "integrity": "sha512-/OxDN6OtAk5KBpGb28T+HZc2M+ADtvRxXrKKbUwtsLgdoxgX13hyy7ek6bFRl5+aBs2yZzB0c4CnQfAtVypW/g==", "dev": true, "requires": { - "call-bind": "^1.0.2", + "call-bind": "^1.0.7", "for-each": "^0.3.3", - "is-typed-array": "^1.1.9" + "gopd": "^1.0.1", + "has-proto": "^1.0.3", + "is-typed-array": "^1.1.13", + "possible-typed-array-names": "^1.0.0" } }, "typedarray": { @@ -27685,19 +23016,10 @@ "integrity": "sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=", "dev": true }, - "typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "dev": true, - "requires": { - "is-typedarray": "^1.0.0" - } - }, "typescript": { - "version": "5.4.5", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", - "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==" + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.2.tgz", + "integrity": "sha512-NW8ByodCSNCwZeghjN3o+JX5OFH0Ojg6sadjEKY4huZ52TqbJTJnDo5+Tw98lSy63NZvi4n+ez5m2u5d4PkZyw==" }, "ua-parser-js": { "version": "1.0.36", @@ -27724,59 +23046,18 @@ "which-boxed-primitive": "^1.0.2" } }, - "undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", - "requires": { - "@fastify/busboy": "^2.0.0" - } - }, "unicorn-magic": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/unicorn-magic/-/unicorn-magic-0.1.0.tgz", "integrity": "sha512-lRfVq8fE8gz6QMBuDM6a+LO3IAzTi05H6gCVaUpir2E1Rwpo4ZUog45KpNXKC/Mn3Yb9UDuHumeFTo9iV/D9FQ==", "dev": true }, - "unique-filename": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unique-filename/-/unique-filename-3.0.0.tgz", - "integrity": "sha512-afXhuC55wkAmZ0P18QsVE6kp8JaxrEokN2HGIoIVv2ijHQd419H0+6EigAFcIzXeMIkcIkNBpB3L/DXB3cTS/g==", - "dev": true, - "requires": { - "unique-slug": "^4.0.0" - } - }, - "unique-slug": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/unique-slug/-/unique-slug-4.0.0.tgz", - "integrity": "sha512-WrcA6AyEfqDX5bWige/4NQfPZMtASNVxdmWR76WESYQVAACSgWcR6e9i0mofqqBxYFtL4oAxPIptY73/0YE1DQ==", - "dev": true, - "requires": { - "imurmurhash": "^0.1.4" - } - }, - "unique-string": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-3.0.0.tgz", - "integrity": "sha512-VGXBUVwxKMBUznyffQweQABPRRW1vHZAbadFZud4pLFAqRGvv/96vafgjWFqzourzr8YonlQiPgH0YCJfawoGQ==", - "dev": true, - "requires": { - "crypto-random-string": "^4.0.0" - } - }, "unpipe": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", "dev": true }, - "untildify": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/untildify/-/untildify-4.0.0.tgz", - "integrity": "sha512-KK8xQ1mkzZeg9inewmFVDNkg3l5LUhoq9kN6iWYB/CC9YMG8HA+c1Q8HwDe6dEX7kErrEVNVBO3fWsVq5iDgtw==", - "dev": true - }, "update-browserslist-db": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.0.7.tgz", @@ -27787,36 +23068,6 @@ "picocolors": "^1.0.0" } }, - "update-notifier": { - "version": "6.0.2", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-6.0.2.tgz", - "integrity": "sha512-EDxhTEVPZZRLWYcJ4ZXjGFN0oP7qYvbXWzEgRm/Yql4dHX5wDbvh89YHP6PK1lzZJYrMtXUuZZz8XGK+U6U1og==", - "dev": true, - "requires": { - "boxen": "^7.0.0", - "chalk": "^5.0.1", - "configstore": "^6.0.0", - "has-yarn": "^3.0.0", - "import-lazy": "^4.0.0", - "is-ci": "^3.0.1", - "is-installed-globally": "^0.4.0", - "is-npm": "^6.0.0", - "is-yarn-global": "^0.4.0", - "latest-version": "^7.0.0", - "pupa": "^3.1.0", - "semver": "^7.3.7", - "semver-diff": "^4.0.0", - "xdg-basedir": "^5.1.0" - }, - "dependencies": { - "chalk": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.0.1.tgz", - "integrity": "sha512-Fo07WOYGqMfCWHOzSXOt2CxDbC6skS/jO9ynEcmpANMoPrD+W1r1K6Vx7iNm+AQmETU1Xr2t+n8nzkV9t6xh3w==", - "dev": true - } - } - }, "uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -27875,15 +23126,6 @@ "spdx-expression-parse": "^3.0.0" } }, - "validate-npm-package-name": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/validate-npm-package-name/-/validate-npm-package-name-5.0.0.tgz", - "integrity": "sha512-YuKoXDAhBYxY7SfOKxHBDoSyENFeW5VvIIQp2TGQuit8gpK6MnWaQelBKxso72DoxTZfZdcP3W90LqpSkgPzLQ==", - "dev": true, - "requires": { - "builtins": "^5.0.0" - } - }, "vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -27942,59 +23184,16 @@ "dev": true }, "which-typed-array": { - "version": "1.1.13", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.13.tgz", - "integrity": "sha512-P5Nra0qjSncduVPEAr7xhoF5guty49ArDTwzJ/yNuPIbZppyRxFQsRCWrocxIY+CnMVG+qfbU2FmDKyvSGClow==", + "version": "1.1.15", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", + "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", "dev": true, "requires": { - "available-typed-arrays": "^1.0.5", - "call-bind": "^1.0.4", + "available-typed-arrays": "^1.0.7", + "call-bind": "^1.0.7", "for-each": "^0.3.3", "gopd": "^1.0.1", - "has-tostringtag": "^1.0.0" - } - }, - "wide-align": { - "version": "1.1.5", - "resolved": "https://registry.npmjs.org/wide-align/-/wide-align-1.1.5.tgz", - "integrity": "sha512-eDMORYaPNZ4sQIuuYPDHdQvf4gyCF9rEEV/yPxGfwPkRodwEgiMUUXTx/dex+Me0wxx53S+NgUHaP7y3MGlDmg==", - "dev": true, - "requires": { - "string-width": "^1.0.2 || 2 || 3 || 4" - }, - "dependencies": { - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - }, - "string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - } - } - } - }, - "widest-line": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-4.0.1.tgz", - "integrity": "sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==", - "dev": true, - "requires": { - "string-width": "^5.0.1" + "has-tostringtag": "^1.0.2" } }, "wordwrap": { @@ -28039,42 +23238,6 @@ } } }, - "wrap-ansi-cjs": { - "version": "npm:wrap-ansi@7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, - "requires": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "dependencies": { - "emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, - "is-fullwidth-code-point": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", - "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", - "dev": true - }, - "string-width": { - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "requires": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - } - } - } - }, "wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", @@ -28098,12 +23261,6 @@ "dev": true, "requires": {} }, - "xdg-basedir": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", - "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", - "dev": true - }, "xml": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/xml/-/xml-1.0.1.tgz", @@ -28135,9 +23292,9 @@ "dev": true }, "yaml": { - "version": "2.4.3", - "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.4.3.tgz", - "integrity": "sha512-sntgmxj8o7DE7g/Qi60cqpLBA3HG3STcDA0kO+WfB05jEKhZMbY7umNm2rBpQvsmZ16/lPXCJGW2672dgOUkrg==", + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.5.1.tgz", + "integrity": "sha512-bLQOjaX/ADgQ20isPJRvF0iRUHIxVhYvr53Of7wGcWlO2jvtUlH5m87DsmulFVxRpNLOnI4tB6p/oh8D7kpn9Q==", "dev": true }, "yaml-ast-parser": { diff --git a/package.json b/package.json index 5d44fb5e..433570db 100644 --- a/package.json +++ b/package.json @@ -8,14 +8,16 @@ "audit:fix": "npm audit fix", "audit:check": "npx audit-ci --config ./audit-ci.jsonc", "build": "npm run build:openapi; npm run build:dto; npm run build:schemas; tsc -p ./tsconfig.build.json", - "build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:v2.0; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter:v2.0.0; npm run build:dto:sdk-scheme-adapter:v2.1.0;", - "build:schemas": "npm run build:schemas:fspiop:v2.0; npm run build:schemas:sdk-scheme-adapter:v2.0.0; npm run build:schemas:sdk-scheme-adapter:v2.1.0;", + "build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:v2.0; npm run build:dto:v2.0_ISO20022; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter:v2.0.0; npm run build:dto:sdk-scheme-adapter:v2.1.0;", + "build:schemas": "npm run build:schemas:fspiop:v2.0; npm run build:schemas:fspiop:v2.0_ISO20022; npm run build:schemas:sdk-scheme-adapter:v2.0.0; npm run build:schemas:sdk-scheme-adapter:v2.1.0;", "build:schemas:fspiop:v2.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/fspiop-rest-v2.0-openapi3-snippets.yaml src/fspiop/v2_0", + "build:schemas:fspiop:v2.0_ISO20022": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml src/fspiop/v2_0_ISO20022", "build:schemas:sdk-scheme-adapter:v2.0.0": "npm run build:schemas:sdk-scheme-adapter:backend:v2.0.0; npm run build:schemas:sdk-scheme-adapter:outbound:v2.0.0;", "build:schemas:sdk-scheme-adapter:v2.1.0": "npm run build:schemas:sdk-scheme-adapter:backend:v2.1.0; npm run build:schemas:sdk-scheme-adapter:outbound:v2.1.0;", "build:dto:v1.0": "openapi-typescript docs/fspiop-rest-v1.0-openapi3-snippets.yaml --output src/fspiop/v1_0/openapi.ts", "build:dto:v1.1": "openapi-typescript docs/fspiop-rest-v1.1-openapi3-snippets.yaml --output src/fspiop/v1_1/openapi.ts", "build:dto:v2.0": "openapi-typescript docs/fspiop-rest-v2.0-openapi3-snippets.yaml --output src/fspiop/v2_0/openapi.ts", + "build:dto:v2.0_ISO20022": "openapi-typescript docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml --output src/fspiop/v2_0_ISO20022/openapi.ts", "build:dto:thirdparty": "openapi-typescript docs/thirdparty-openapi3-snippets.yaml --output src/thirdparty/openapi.ts", "build:dto:sdk-scheme-adapter:v2.0.0": "npm run build:dto:sdk-scheme-adapter:backend:v2.0.0; npm run build:dto:sdk-scheme-adapter:outbound:v2.0.0;", "build:dto:sdk-scheme-adapter:v2.1.0": "npm run build:dto:sdk-scheme-adapter:backend:v2.1.0; npm run build:dto:sdk-scheme-adapter:outbound:v2.1.0;", @@ -23,10 +25,11 @@ "build:dto:sdk-scheme-adapter:outbound:v2.0.0": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts", "build:dto:sdk-scheme-adapter:backend:v2.1.0": "openapi-typescript docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts", "build:dto:sdk-scheme-adapter:outbound:v2.1.0": "openapi-typescript docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml --output src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts", - "build:openapi": "npm run build:v1.0; npm run build:v1.1; npm run build:refactor:fspiop:v1.1; npm run build:v2.0; npm run build:refactor:fspiop:v2.0; npm run build:thirdparty; npm run build:sdk-scheme-adapter:v2.0.0; npm run build:sdk-scheme-adapter:v2.1.0;", + "build:openapi": "npm run build:v1.0; npm run build:v1.1; npm run build:refactor:fspiop:v1.1; npm run build:v2.0; npm run build:refactor:fspiop:v2.0; npm run build:v2.0_ISO20022; npm run build:refactor:fspiop:v2.0_ISO20022; npm run build:thirdparty; npm run build:sdk-scheme-adapter:v2.0.0; npm run build:sdk-scheme-adapter:v2.1.0;", "build:v1.0": "openapi bundle --output docs/fspiop-rest-v1.0-openapi3-snippets.yaml --ext yaml fspiop/v1_0/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v1.0-openapi3-snippets.yaml", "build:v1.1": "openapi bundle --output docs/fspiop-rest-v1.1-openapi3-snippets.yaml --ext yaml fspiop/v1_1/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v1.1-openapi3-snippets.yaml", "build:v2.0": "openapi bundle --output docs/fspiop-rest-v2.0-openapi3-snippets.yaml --ext yaml fspiop/v2_0/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v2.0-openapi3-snippets.yaml", + "build:v2.0_ISO20022": "openapi bundle --output docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml --ext yaml fspiop/v2_0_ISO20022/openapi3/openapi.yaml && swagger-cli validate docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml", "build:thirdparty": "openapi bundle --output docs/thirdparty-openapi3-snippets.yaml --ext yaml thirdparty/v1_0/openapi3/openapi.yaml && swagger-cli validate docs/thirdparty-openapi3-snippets.yaml", "build:thirdparty-dfsp": "swagger-cli bundle -o ./thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml -t yaml ./thirdparty/v1_0/openapi3/thirdparty-dfsp-api.template.yaml", "build:thirdparty-pisp": "swagger-cli bundle -o ./thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml -t yaml ./thirdparty/v1_0/openapi3/thirdparty-pisp-api.template.yaml", @@ -42,6 +45,7 @@ "build:schemas:sdk-scheme-adapter:outbound:v2.1.0": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_1_0/outbound", "build:refactor:fspiop:v1.1": "npx ts-node --transpile-only src/scripts/openapi-refactor.ts docs/fspiop-rest-v1.1-openapi3-snippets.yaml docs/fspiop-rest-v1.1-openapi3-snippets.yaml", "build:refactor:fspiop:v2.0": "npx ts-node --transpile-only src/scripts/openapi-refactor.ts docs/fspiop-rest-v2.0-openapi3-snippets.yaml docs/fspiop-rest-v2.0-openapi3-snippets.yaml", + "build:refactor:fspiop:v2.0_ISO20022": "npx ts-node --transpile-only src/scripts/openapi-refactor.ts docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml", "lint": "eslint --ext ts --ext js test src", "lint:fix": "eslint --fix --ext ts --ext js test src", "prepare": "husky install && npm run build", @@ -82,48 +86,48 @@ "js-yaml": "^4.1.0", "json-refs": "^3.0.15", "openapi-types": "^12.1.3", - "openapi-typescript": "^6.7.6", - "ts-auto-mock": "^3.7.3" + "openapi-typescript": "^7.4.0", + "ts-auto-mock": "^3.7.4" }, "overrides": { "@types/cacheable-request": "^6.0.2", "@types/responselike": "^1.0.0" }, "devDependencies": { - "@commitlint/cli": "^19.3.0", - "@commitlint/config-conventional": "^19.2.2", - "@redocly/openapi-cli": "^1.0.0-beta.94", + "@commitlint/cli": "^19.4.1", + "@commitlint/config-conventional": "^19.4.1", + "@redocly/openapi-cli": "^1.0.0-beta.95", "@redocly/cli": "^1.5.0", "@types/jest": "^29.5.12", "@types/js-yaml": "^4.0.9", - "@typescript-eslint/eslint-plugin": "^7.11.0", - "@typescript-eslint/parser": "^7.11.0", - "audit-ci": "^7.0.0", + "@typescript-eslint/eslint-plugin": "^8.4.0", + "@typescript-eslint/parser": "^8.4.0", + "audit-ci": "^7.1.0", "browser-sync": "^3.0.2", - "diff": "^5.2.0", + "diff": "^7.0.0", "eslint": "^8.55.0", "eslint-config-prettier": "^9.1.0", "eslint-config-standard": "^17.1.0", - "eslint-import-resolver-typescript": "^3.6.1", + "eslint-import-resolver-typescript": "^3.6.3", "eslint-plugin-cucumber": "^2.0.0", - "eslint-plugin-import": "^2.29.1", + "eslint-plugin-import": "^2.30.0", "eslint-plugin-node": "^11.1.0", - "eslint-plugin-prettier": "^5.1.3", + "eslint-plugin-prettier": "^5.2.1", "eslint-plugin-promise": "^6.2.0", "eslint-plugin-standard": "^5.0.0", - "husky": "9.0.11", + "husky": "9.1.5", "jest": "^29.7.0", "jest-junit": "^16.0.0", - "lint-staged": "^15.2.5", - "npm-check-updates": "^16.14.20", - "prettier": "^3.3.0", + "lint-staged": "^15.2.10", + "npm-check-updates": "^17.1.1", + "prettier": "^3.3.3", "standard-version": "^9.5.0", "swagger-cli": "^4.0.4", - "ts-jest": "^29.1.4", + "ts-jest": "^29.2.5", "ts-node": "^10.9.2", - "ts-patch": "^3.1.2", - "tslib": "^2.6.2", - "typescript": "^5.4.5" + "ts-patch": "^3.2.1", + "tslib": "^2.7.0", + "typescript": "^5.6.2" }, "publishConfig": { "registry": "https://registry.npmjs.org/" diff --git a/src/fspiop/v1_0/openapi.ts b/src/fspiop/v1_0/openapi.ts index 1cb8cadd..2712286a 100644 --- a/src/fspiop/v1_0/openapi.ts +++ b/src/fspiop/v1_0/openapi.ts @@ -3,3753 +3,4831 @@ * Do not make direct changes to the file. */ - export interface paths { - "/interface": { - /** @description Essential path to include schema components that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */ - post: operations["Interface"]; - }; - "/participants/{Type}/{ID}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). - */ - post: operations["ParticipantsByIDAndType"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants/{Type}/{ID}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsErrorByTypeAndID"]; - }; - "/participants/{Type}/{ID}/{SubId}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsSubIdByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsSubIdByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). - */ - post: operations["ParticipantsSubIdByTypeAndIDPost"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsSubIdByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/participants/{Type}/{ID}/{SubId}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsSubIdErrorByTypeAndID"]; - }; - "/participants": { - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - post: operations["Participants1"]; - }; - "/participants/{ID}": { - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - put: operations["putParticipantsByID"]; - }; - "/participants/{ID}/error": { - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - put: operations["ParticipantsByIDAndError"]; - }; - "/parties/{Type}/{ID}": { - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - get: operations["PartiesByTypeAndID"]; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - put: operations["PartiesByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/parties/{Type}/{ID}/error": { - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. - */ - put: operations["PartiesErrorByTypeAndID"]; - }; - "/parties/{Type}/{ID}/{SubId}": { - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - get: operations["PartiesSubIdByTypeAndID"]; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - put: operations["PartiesSubIdByTypeAndIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/parties/{Type}/{ID}/{SubId}/error": { - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["PartiesSubIdErrorByTypeAndID"]; - }; - "/transactionRequests": { - /** - * Perform transaction request - * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. - */ - post: operations["TransactionRequests"]; - }; - "/transactionRequests/{ID}": { - /** - * Retrieve transaction request information - * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. - */ - get: operations["TransactionRequestsByID"]; - /** - * Return transaction request information - * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - put: operations["TransactionRequestsByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transactionRequests/{ID}/error": { - /** - * Return transaction request information error - * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - put: operations["TransactionRequestsErrorByID"]; - }; - "/quotes": { - /** - * Calculate quote - * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. - */ - post: operations["Quotes"]; - }; - "/quotes/{ID}": { - /** - * Retrieve quote information - * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. - */ - get: operations["QuotesByID"]; - /** - * Return quote information - * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - put: operations["QuotesByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/quotes/{ID}/error": { - /** - * Return quote information error - * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - put: operations["QuotesByIDAndError"]; - }; - "/authorizations/{ID}": { - /** - * Perform authorization - * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* - * - * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. - * - * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. - * - * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. - * - * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. - * - * The following is an example URI containing all the required key-value pairs in the query string*:* - * - * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` - */ - get: operations["AuthorizationsByIDGet"]; - /** - * Return authorization result - * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. - */ - put: operations["AuthorizationsByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/authorizations/{ID}/error": { - /** - * Return authorization error - * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. - */ - put: operations["AuthorizationsByIDAndError"]; - }; - "/transfers": { - /** - * Perform transfer - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. - */ - post: operations["transfers"]; - }; - "/transfers/{ID}": { - /** - * Retrieve transfer information - * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. - */ - get: operations["TransfersByIDGet"]; - /** - * Return transfer information - * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. - */ - put: operations["TransfersByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transfers/{ID}/error": { - /** - * Return transfer information error - * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. - */ - put: operations["TransfersByIDAndError"]; - }; - "/transactions/{ID}": { - /** - * Retrieve transaction information - * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). - */ - get: operations["TransactionsByID"]; - /** - * Return transaction information - * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - put: operations["TransactionsByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transactions/{ID}/error": { - /** - * Return transaction information error - * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - put: operations["TransactionsErrorByID"]; - }; - "/bulkQuotes": { - /** - * Calculate bulk quote - * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. - */ - post: operations["BulkQuotes"]; - }; - "/bulkQuotes/{ID}": { - /** - * Retrieve bulk quote information - * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. - */ - get: operations["BulkQuotesByID"]; - /** - * Return bulk quote information - * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - put: operations["BulkQuotesByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/bulkQuotes/{ID}/error": { - /** - * Return bulk quote information error - * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - put: operations["BulkQuotesErrorByID"]; - }; - "/bulkTransfers": { - /** - * Perform bulk transfer - * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. - */ - post: operations["BulkTransfers"]; - }; - "/bulkTransfers/{ID}": { - /** - * Retrieve bulk transfer information - * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. - */ - get: operations["BulkTransferByID"]; - /** - * Return bulk transfer information - * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - put: operations["BulkTransfersByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/bulkTransfers/{ID}/error": { - /** - * Return bulk transfer information error - * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - put: operations["BulkTransfersErrorByID"]; - }; + "/interface": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Essential path to include schema components that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */ + post: operations["Interface"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). + */ + post: operations["ParticipantsByIDAndType"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsSubIdByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsSubIdByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). + */ + post: operations["ParticipantsSubIdByTypeAndIDPost"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsSubIdByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create bulk participant information + * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. + */ + post: operations["Participants1"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information + * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. + */ + put: operations["putParticipantsByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information error + * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. + */ + put: operations["ParticipantsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesByTypeAndID2"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. + */ + put: operations["PartiesErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesSubIdByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesSubIdByTypeAndIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["PartiesSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transaction request + * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. + */ + post: operations["TransactionRequests"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transaction request information + * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. + */ + get: operations["TransactionRequestsByID"]; + /** + * Return transaction request information + * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. + */ + put: operations["TransactionRequestsByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transaction request information error + * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. + */ + put: operations["TransactionRequestsErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate quote + * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. + */ + post: operations["Quotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve quote information + * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. + */ + get: operations["QuotesByID"]; + /** + * Return quote information + * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return quote information error + * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/authorizations/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Perform authorization + * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* + * + * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. + * + * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. + * + * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. + * + * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. + * + * The following is an example URI containing all the required key-value pairs in the query string*:* + * + * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` + */ + get: operations["AuthorizationsByIDGet"]; + /** + * Return authorization result + * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. + */ + put: operations["AuthorizationsByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/authorizations/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return authorization error + * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. + */ + put: operations["AuthorizationsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transfer + * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. + */ + post: operations["transfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transfer information + * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. + */ + get: operations["TransfersByIDGet"]; + /** + * Return transfer information + * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. + */ + put: operations["TransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transfer information error + * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. + */ + put: operations["TransfersByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transaction information + * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). + */ + get: operations["TransactionsByID"]; + /** + * Return transaction information + * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. + */ + put: operations["TransactionsByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transaction information error + * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. + */ + put: operations["TransactionsErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate bulk quote + * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. + */ + post: operations["BulkQuotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve bulk quote information + * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. + */ + get: operations["BulkQuotesByID"]; + /** + * Return bulk quote information + * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. + */ + put: operations["BulkQuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk quote information error + * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. + */ + put: operations["BulkQuotesErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform bulk transfer + * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. + */ + post: operations["BulkTransfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve bulk transfer information + * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. + */ + get: operations["BulkTransferByID"]; + /** + * Return bulk transfer information + * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. + */ + put: operations["BulkTransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk transfer information error + * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. + */ + put: operations["BulkTransfersErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - */ - Amount: string; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * AuthenticationInfo - * @description Data model for the complex type AuthenticationInfo. - */ - AuthenticationInfo: { - /** - * @description Type of authentication. - * @example OTP - */ - authentication: string; - /** - * @description Authentication value. - * @example 1234 - */ - authenticationValue: string; - }; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE"; - /** - * OtpValue - * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed. - */ - OtpValue: string; - /** - * QRCODE - * @description QR code used as a One Time Password. - */ - QRCODE: string; - /** - * AuthenticationValue - * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. - */ - AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"]; - /** - * AuthorizationResponse - * @description Below are the allowed values for the enumeration. - * - ENTERED - Consumer entered the authentication value. - * - REJECTED - Consumer rejected the transaction. - * - RESEND - Consumer requested to resend the authentication value. - * @enum {string} - */ - AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND"; - /** - * BalanceOfPayments - * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. - */ - BalanceOfPayments: string; - /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ - BinaryString: string; - /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */ - BinaryString32: string; - /** - * BulkTransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP. - * - PENDING - Payee FSP has validated the bulk transfer. - * - ACCEPTED - Payee FSP has accepted to process the bulk transfer. - * - PROCESSING - Payee FSP has started to transfer fund to the Payees. - * - COMPLETED - Payee FSP has completed transfer of funds to the Payees. - * - REJECTED - Payee FSP has rejected to process the bulk transfer. - * @enum {string} - */ - BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED"; - /** - * Code - * @description Any code/token returned by the Payee FSP (TokenCode Type). - */ - Code: string; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - */ - CorrelationId: string; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** - * Date - * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”. - */ - Date: string; - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - */ - DateOfBirth: string; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - */ - DateTime: string; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * FirstName - * @description First name of the Party (Name Type). - */ - FirstName: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - */ - IlpFulfilment: string; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - */ - IlpPacket: string; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. - */ - PartyIdInfo: { - /** - * @description Type of the identifier. - * @example PERSONAL_ID - */ - partyIdType: string; - /** - * @description An identifier for the Party. - * @example 16135551212 - */ - partyIdentifier: string; - /** - * @description A sub-identifier or sub-type for the Party. - * @example DRIVING_LICENSE - */ - partySubIdOrType?: string; - /** - * @description FSP ID (if known). - * @example 1234 - */ - fspId?: string; - }; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - /** - * @description Party’s first name. - * @example Henrik - */ - firstName?: string; - /** - * @description Party’s middle name. - * @example Johannes - */ - middleName?: string; - /** - * @description Party’s last name. - * @example Karlsson - */ - lastName?: string; - }; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - /** @description First, middle and last name for the Party. */ - complexName?: components["schemas"]["PartyComplexName"]; - /** - * @description Date of birth for the Party. - * @example 1966-06-16 - */ - dateOfBirth?: string; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - /** @description Party Id type, id, sub ID or type, and FSP Id. */ - partyIdInfo: components["schemas"]["PartyIdInfo"]; - /** - * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. - * @example 4321 - */ - merchantClassificationCode?: string; - /** - * @description Display name of the Party, could be a real name or a nick name. - * @example Henrik Karlsson - */ - name?: string; - /** @description Personal information used to verify identity of Party such as first, middle, last name and date of birth. */ - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** - * Refund - * @description Data model for the complex type Refund. - */ - Refund: { - /** - * @description Reference to the original transaction ID that is requested to be refunded. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - originalTransactionId: string; - /** - * @description Free text indicating the reason for the refund. - * @example Free text indicating reason for the refund. - */ - refundReason?: string; - }; - /** - * TransactionType - * @description Data model for the complex type TransactionType. - */ - TransactionType: { - /** - * @description Deposit, withdrawal, refund, … - * @example DEPOSIT - */ - scenario: string; - /** - * @description Possible sub-scenario, defined locally within the scheme. - * @example Locally defined sub-scenario. - */ - subScenario?: string; - /** - * @description Who is initiating the transaction - Payer or Payee. - * @example PAYEE - */ - initiator: string; - /** - * @description Consumer, agent, business, … - * @example CONSUMER - */ - initiatorType: string; - /** @description Extra information specific to a refund scenario. Should only be populated if scenario is REFUND. */ - refundInfo?: components["schemas"]["Refund"]; - /** - * @description Balance of Payments code. - * @example 123 - */ - balanceOfPayments?: string; - }; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - /** @description Extension key. */ - key: string; - /** @description Extension value. */ - value: string; - }; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * IndividualQuote - * @description Data model for the complex type IndividualQuote. - */ - IndividualQuote: { - /** - * @description Identifies the quote message. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - quoteId: string; - /** - * @description Identifies the transaction message. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transactionId: string; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - /** - * @description SEND for sendAmount, RECEIVE for receiveAmount. - * @example RECEIVE - */ - amountType: string; - amount: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 123.45 - */ - amount?: string; - }; - fees?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 1.45 - */ - amount?: string; - }; - /** @description Type of transaction that the quote is requested for. */ - transactionType: components["schemas"]["TransactionType"]; - /** - * @description Memo that will be attached to the transaction. - * @example Note sent to Payee. - */ - note?: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Integer - * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. - */ - Integer: string; - /** - * LastName - * @description Last name of the Party (Name Type). - */ - LastName: string; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - */ - Longitude: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - */ - MiddleName: string; - /** - * Name - * @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. - * - * 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 ( ). - * - * **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. - */ - Name: string; - /** - * Note - * @description Memo assigned to transaction. - */ - Note: string; - /** - * PartyIdentifier - * @description Identifier of the Party. - */ - PartyIdentifier: string; - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * PersonalIdentifierType - * @description Below are the allowed values for the enumeration. - * - PASSPORT - A passport number is used as reference to a Party. - * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party. - * - DRIVING_LICENSE - A driving license is used as reference to a Party. - * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party. - * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party. - * - EMPLOYER_ID - A tax identification number is used as reference to a Party. - * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party. - * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party. - * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party. - * - HEALTH_CARD - A health card number is used as reference to a Party. - * - VOTERS_ID - A voter’s identification number is used as reference to a Party. - * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party. - * - OTHER_ID - Any other type of identification type number is used as reference to a Party. - * @enum {string} - */ - PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID"; - /** - * RefundReason - * @description Reason for the refund. - */ - RefundReason: string; - /** - * TokenCode - * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z. - */ - TokenCode: string; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - /** - * @description Currency of the amount. - * @example USD - */ - currency: string; - /** - * @description Amount of Money. - * @example 123.45 - */ - amount: string; - }; - /** - * Transaction - * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request. - */ - Transaction: { - /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */ - transactionId: string; - /** @description ID of the quote, the ID is decided by the Payer FSP during the creation of the quote. */ - quoteId: string; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - /** @description Information about the Payer in the proposed financial transaction. */ - payer: components["schemas"]["Party"]; - /** @description Transaction amount to be sent. */ - amount: components["schemas"]["Money"]; - /** @description Type of the transaction. */ - transactionType: components["schemas"]["TransactionType"]; - /** @description Memo associated to the transaction, intended to the Payee. */ - note?: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionInitiator - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * @enum {string} - */ - TransactionInitiator: "PAYER" | "PAYEE"; - /** - * TransactionInitiatorType - * @description Below are the allowed values for the enumeration. - * - CONSUMER - Consumer is the initiator of the transaction. - * - AGENT - Agent is the initiator of the transaction. - * - BUSINESS - Business is the initiator of the transaction. - * - DEVICE - Device is the initiator of the transaction. - * @enum {string} - */ - TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** - * TransactionRequestState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. - * - PENDING - Payer FSP has sent the transaction request to the Payer. - * - ACCEPTED - Payer has approved the transaction. - * - REJECTED - Payer has rejected the transaction. - * @enum {string} - */ - TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * TransactionScenario - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. - * - 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. - * - REFUND - Used for performing a refund of transaction. - * @enum {string} - */ - TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; - /** - * TransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. - * - PENDING - Payee FSP has validated the transaction. - * - COMPLETED - Payee FSP has successfully performed the transaction. - * - REJECTED - Payee FSP has failed to perform the transaction. - * @enum {string} - */ - TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - */ - TransactionSubScenario: string; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** - * UndefinedEnum - * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_). - */ - UndefinedEnum: string; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - /** - * @description Specific error number. - * @example 5100 - */ - errorCode: string; - /** - * @description Error description string. - * @example This is an error description. - */ - errorDescription: string; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ErrorInformationResponse - * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. - */ - ErrorInformationResponse: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * ParticipantsTypeIDPutResponse - * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. - */ - ParticipantsTypeIDPutResponse: { - /** - * @description FSP Identifier that the Party belongs to. - * @example 1234 - */ - fspId?: string; - }; - /** - * ParticipantsTypeIDSubIDPostRequest - * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. - */ - ParticipantsTypeIDSubIDPostRequest: { - /** - * @description FSP Identifier that the Party belongs to. - * @example 1234 - */ - fspId: string; - /** - * @description Indicate that the provided Currency is supported by the Party. - * @example USD - */ - currency?: string; - }; - /** - * ErrorInformationObject - * @description Data model for the complex type object that contains ErrorInformation. - */ - ErrorInformationObject: { - errorInformation: components["schemas"]["ErrorInformation"]; - }; - /** - * ParticipantsPostRequest - * @description The object sent in the POST /participants request. - */ - ParticipantsPostRequest: { - /** - * @description The ID of the request, decided by the client. Used for identification of the callback from the server. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - requestId: string; - /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */ - partyList: components["schemas"]["PartyIdInfo"][]; - /** - * @description Indicate that the provided Currency is supported by each PartyIdInfo in the list. - * @example USD - */ - currency?: string; - }; - /** - * PartyResult - * @description Data model for the complex type PartyResult. - */ - PartyResult: { - /** @description Party Id type, id, sub ID or type, and FSP Id. */ - partyId: components["schemas"]["PartyIdInfo"]; - /** @description If the Party failed to be added, error information should be provided. Otherwise, this parameter should be empty to indicate success. */ - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * ParticipantsIDPutResponse - * @description The object sent in the PUT /participants/{ID} callback. - */ - ParticipantsIDPutResponse: { - /** @description List of PartyResult elements that were either created or failed to be created. */ - partyList: components["schemas"]["PartyResult"][]; - /** - * @description Indicate that the provided Currency was set to be supported by each successfully added PartyIdInfo. - * @example USD - */ - currency?: string; - }; - /** - * PartiesTypeIDPutResponse - * @description The object sent in the PUT /parties/{Type}/{ID} callback. - */ - PartiesTypeIDPutResponse: { - party: components["schemas"]["Party"]; - }; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - /** - * @description Latitude of the Party. - * @example +45.4215 - */ - latitude: string; - /** - * @description Longitude of the Party. - * @example +75.6972 - */ - longitude: string; - }; - /** - * TransactionRequestsPostRequest - * @description The object sent in the POST /transactionRequests request. - */ - TransactionRequestsPostRequest: { - /** - * @description Common ID between the FSPs for the transaction request object, decided by the Payee FSP. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transactionRequestId: string; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - /** @description Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction. */ - payer: components["schemas"]["PartyIdInfo"]; - /** @description Requested amount to be transferred from the Payer to Payee. */ - amount: components["schemas"]["Money"]; - /** @description Type of transaction. */ - transactionType: components["schemas"]["TransactionType"]; - /** - * @description Reason for the transaction request, intended to the Payer. - * @example Free-text memo. - */ - note?: string; - /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ - geoCode?: components["schemas"]["GeoCode"]; - /** - * @description OTP or QR Code, otherwise empty. - * @example OTP - */ - authenticationType?: string; - /** - * @description Can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, Merchant to know that their request has a time limit. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration?: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionRequestsIDPutResponse - * @description The object sent in the PUT /transactionRequests/{ID} callback. - */ - TransactionRequestsIDPutResponse: { - /** - * @description Identifies a related transaction (if a transaction has been created). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transactionId?: string; - /** - * @description State of the transaction request. - * @example RECEIVED - */ - transactionRequestState: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * QuotesPostRequest - * @description The object sent in the POST /quotes request. - */ - QuotesPostRequest: { - /** - * @description Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - quoteId: string; - /** - * @description Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. - * @example a8323bc6-c228-4df2-ae82-e5a997baf899 - */ - transactionId: string; - /** - * @description Identifies an optional previously-sent transaction request. - * @example a8323bc6-c228-4df2-ae82-e5a997baf890 - */ - transactionRequestId?: string; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - payer: { - partyIdInfo?: { - /** - * @description Information about the Payer in the proposed financial transaction. Type of the identifier. - * @example PERSONAL_ID - */ - partyIdType?: string; - /** - * @description Information about the Payer in the proposed financial transaction. An indentifier for the Party. - * @example 16135551212 - */ - partyIdentifier?: string; - /** - * @description Information about the Payer in the proposed financial transaction. A sub-identifier or sub-type for the Party. - * @example PASSPORT - */ - partySubIdOrType?: string; - /** - * @description FSP ID (if known). - * @example 1234 - */ - fspId?: string; - }; - /** - * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. - * @example 1234 - */ - merchantClassificationCode?: string; - /** - * @description Display name of the Party, could be a real name or a nick name. - * @example Lars Bergqvist - */ - name?: string; - personalInfo?: { - complexName?: { + schemas: { + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + */ + Amount: string; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * AuthenticationInfo + * @description Data model for the complex type AuthenticationInfo. + */ + AuthenticationInfo: { + /** + * @description Type of authentication. + * @example OTP + */ + authentication: string; + /** + * @description Authentication value. + * @example 1234 + */ + authenticationValue: string; + }; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE"; + /** + * OtpValue + * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed. + */ + OtpValue: string; + /** + * QRCODE + * @description QR code used as a One Time Password. + */ + QRCODE: string; + /** + * AuthenticationValue + * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. + */ + AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"]; + /** + * AuthorizationResponse + * @description Below are the allowed values for the enumeration. + * - ENTERED - Consumer entered the authentication value. + * - REJECTED - Consumer rejected the transaction. + * - RESEND - Consumer requested to resend the authentication value. + * @enum {string} + */ + AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND"; + /** + * BalanceOfPayments + * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. + */ + BalanceOfPayments: string; + /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ + BinaryString: string; + /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */ + BinaryString32: string; + /** + * BulkTransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP. + * - PENDING - Payee FSP has validated the bulk transfer. + * - ACCEPTED - Payee FSP has accepted to process the bulk transfer. + * - PROCESSING - Payee FSP has started to transfer fund to the Payees. + * - COMPLETED - Payee FSP has completed transfer of funds to the Payees. + * - REJECTED - Payee FSP has rejected to process the bulk transfer. + * @enum {string} + */ + BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED"; + /** + * Code + * @description Any code/token returned by the Payee FSP (TokenCode Type). + */ + Code: string; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + */ + CorrelationId: string; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** + * Date + * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”. + */ + Date: string; + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + */ + DateOfBirth: string; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + */ + DateTime: string; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * FirstName + * @description First name of the Party (Name Type). + */ + FirstName: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + */ + IlpFulfilment: string; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + */ + IlpPacket: string; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. + */ + PartyIdInfo: { + /** + * @description Type of the identifier. + * @example PERSONAL_ID + */ + partyIdType: string; + /** + * @description An identifier for the Party. + * @example 16135551212 + */ + partyIdentifier: string; + /** + * @description A sub-identifier or sub-type for the Party. + * @example DRIVING_LICENSE + */ + partySubIdOrType?: string; + /** + * @description FSP ID (if known). + * @example 1234 + */ + fspId?: string; + }; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + /** + * @description Party’s first name. + * @example Henrik + */ + firstName?: string; + /** + * @description Party’s middle name. + * @example Johannes + */ + middleName?: string; + /** + * @description Party’s last name. + * @example Karlsson + */ + lastName?: string; + }; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + /** @description First, middle and last name for the Party. */ + complexName?: components["schemas"]["PartyComplexName"]; + /** + * @description Date of birth for the Party. + * @example 1966-06-16 + */ + dateOfBirth?: string; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + /** @description Party Id type, id, sub ID or type, and FSP Id. */ + partyIdInfo: components["schemas"]["PartyIdInfo"]; + /** + * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. + * @example 4321 + */ + merchantClassificationCode?: string; + /** + * @description Display name of the Party, could be a real name or a nick name. + * @example Henrik Karlsson + */ + name?: string; + /** @description Personal information used to verify identity of Party such as first, middle, last name and date of birth. */ + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** + * Refund + * @description Data model for the complex type Refund. + */ + Refund: { + /** + * @description Reference to the original transaction ID that is requested to be refunded. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + originalTransactionId: string; + /** + * @description Free text indicating the reason for the refund. + * @example Free text indicating reason for the refund. + */ + refundReason?: string; + }; + /** + * TransactionType + * @description Data model for the complex type TransactionType. + */ + TransactionType: { + /** + * @description Deposit, withdrawal, refund, … + * @example DEPOSIT + */ + scenario: string; + /** + * @description Possible sub-scenario, defined locally within the scheme. + * @example Locally defined sub-scenario. + */ + subScenario?: string; + /** + * @description Who is initiating the transaction - Payer or Payee. + * @example PAYEE + */ + initiator: string; + /** + * @description Consumer, agent, business, … + * @example CONSUMER + */ + initiatorType: string; + /** @description Extra information specific to a refund scenario. Should only be populated if scenario is REFUND. */ + refundInfo?: components["schemas"]["Refund"]; + /** + * @description Balance of Payments code. + * @example 123 + */ + balanceOfPayments?: string; + }; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + /** @description Extension key. */ + key: string; + /** @description Extension value. */ + value: string; + }; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * IndividualQuote + * @description Data model for the complex type IndividualQuote. + */ + IndividualQuote: { + /** + * @description Identifies the quote message. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + quoteId: string; + /** + * @description Identifies the transaction message. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transactionId: string; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + /** + * @description SEND for sendAmount, RECEIVE for receiveAmount. + * @example RECEIVE + */ + amountType: string; + amount: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 123.45 + */ + amount?: string; + }; + fees?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 1.45 + */ + amount?: string; + }; + /** @description Type of transaction that the quote is requested for. */ + transactionType: components["schemas"]["TransactionType"]; + /** + * @description Memo that will be attached to the transaction. + * @example Note sent to Payee. + */ + note?: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Integer + * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. + */ + Integer: string; + /** + * LastName + * @description Last name of the Party (Name Type). + */ + LastName: string; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + */ + Longitude: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + */ + MiddleName: string; + /** + * Name + * @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. + * + * 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 ( ). + * + * **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. + */ + Name: string; + /** + * Note + * @description Memo assigned to transaction. + */ + Note: string; + /** + * PartyIdentifier + * @description Identifier of the Party. + */ + PartyIdentifier: string; + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * PersonalIdentifierType + * @description Below are the allowed values for the enumeration. + * - PASSPORT - A passport number is used as reference to a Party. + * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party. + * - DRIVING_LICENSE - A driving license is used as reference to a Party. + * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party. + * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party. + * - EMPLOYER_ID - A tax identification number is used as reference to a Party. + * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party. + * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party. + * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party. + * - HEALTH_CARD - A health card number is used as reference to a Party. + * - VOTERS_ID - A voter’s identification number is used as reference to a Party. + * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party. + * - OTHER_ID - Any other type of identification type number is used as reference to a Party. + * @enum {string} + */ + PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID"; + /** + * RefundReason + * @description Reason for the refund. + */ + RefundReason: string; + /** + * TokenCode + * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z. + */ + TokenCode: string; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + /** + * @description Currency of the amount. + * @example USD + */ + currency: string; + /** + * @description Amount of Money. + * @example 123.45 + */ + amount: string; + }; + /** + * Transaction + * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request. + */ + Transaction: { + /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */ + transactionId: string; + /** @description ID of the quote, the ID is decided by the Payer FSP during the creation of the quote. */ + quoteId: string; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + /** @description Information about the Payer in the proposed financial transaction. */ + payer: components["schemas"]["Party"]; + /** @description Transaction amount to be sent. */ + amount: components["schemas"]["Money"]; + /** @description Type of the transaction. */ + transactionType: components["schemas"]["TransactionType"]; + /** @description Memo associated to the transaction, intended to the Payee. */ + note?: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionInitiator + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * @enum {string} + */ + TransactionInitiator: "PAYER" | "PAYEE"; + /** + * TransactionInitiatorType + * @description Below are the allowed values for the enumeration. + * - CONSUMER - Consumer is the initiator of the transaction. + * - AGENT - Agent is the initiator of the transaction. + * - BUSINESS - Business is the initiator of the transaction. + * - DEVICE - Device is the initiator of the transaction. + * @enum {string} + */ + TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** + * TransactionRequestState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. + * - PENDING - Payer FSP has sent the transaction request to the Payer. + * - ACCEPTED - Payer has approved the transaction. + * - REJECTED - Payer has rejected the transaction. + * @enum {string} + */ + TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * TransactionScenario + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. + * - 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. + * - REFUND - Used for performing a refund of transaction. + * @enum {string} + */ + TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; + /** + * TransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. + * - PENDING - Payee FSP has validated the transaction. + * - COMPLETED - Payee FSP has successfully performed the transaction. + * - REJECTED - Payee FSP has failed to perform the transaction. + * @enum {string} + */ + TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + */ + TransactionSubScenario: string; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** + * UndefinedEnum + * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_). + */ + UndefinedEnum: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + /** + * @description Specific error number. + * @example 5100 + */ + errorCode: string; + /** + * @description Error description string. + * @example This is an error description. + */ + errorDescription: string; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorInformationResponse + * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. + */ + ErrorInformationResponse: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * ParticipantsTypeIDPutResponse + * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. + */ + ParticipantsTypeIDPutResponse: { + /** + * @description FSP Identifier that the Party belongs to. + * @example 1234 + */ + fspId?: string; + }; + /** + * ParticipantsTypeIDSubIDPostRequest + * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. + */ + ParticipantsTypeIDSubIDPostRequest: { + /** + * @description FSP Identifier that the Party belongs to. + * @example 1234 + */ + fspId: string; + /** + * @description Indicate that the provided Currency is supported by the Party. + * @example USD + */ + currency?: string; + }; + /** + * ErrorInformationObject + * @description Data model for the complex type object that contains ErrorInformation. + */ + ErrorInformationObject: { + errorInformation: components["schemas"]["ErrorInformation"]; + }; + /** + * ParticipantsPostRequest + * @description The object sent in the POST /participants request. + */ + ParticipantsPostRequest: { + /** + * @description The ID of the request, decided by the client. Used for identification of the callback from the server. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + requestId: string; + /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */ + partyList: components["schemas"]["PartyIdInfo"][]; + /** + * @description Indicate that the provided Currency is supported by each PartyIdInfo in the list. + * @example USD + */ + currency?: string; + }; + /** + * PartyResult + * @description Data model for the complex type PartyResult. + */ + PartyResult: { + /** @description Party Id type, id, sub ID or type, and FSP Id. */ + partyId: components["schemas"]["PartyIdInfo"]; + /** @description If the Party failed to be added, error information should be provided. Otherwise, this parameter should be empty to indicate success. */ + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * ParticipantsIDPutResponse + * @description The object sent in the PUT /participants/{ID} callback. + */ + ParticipantsIDPutResponse: { + /** @description List of PartyResult elements that were either created or failed to be created. */ + partyList: components["schemas"]["PartyResult"][]; + /** + * @description Indicate that the provided Currency was set to be supported by each successfully added PartyIdInfo. + * @example USD + */ + currency?: string; + }; + /** + * PartiesTypeIDPutResponse + * @description The object sent in the PUT /parties/{Type}/{ID} callback. + */ + PartiesTypeIDPutResponse: { + party: components["schemas"]["Party"]; + }; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + /** + * @description Latitude of the Party. + * @example +45.4215 + */ + latitude: string; + /** + * @description Longitude of the Party. + * @example +75.6972 + */ + longitude: string; + }; + /** + * TransactionRequestsPostRequest + * @description The object sent in the POST /transactionRequests request. + */ + TransactionRequestsPostRequest: { + /** + * @description Common ID between the FSPs for the transaction request object, decided by the Payee FSP. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transactionRequestId: string; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + /** @description Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction. */ + payer: components["schemas"]["PartyIdInfo"]; + /** @description Requested amount to be transferred from the Payer to Payee. */ + amount: components["schemas"]["Money"]; + /** @description Type of transaction. */ + transactionType: components["schemas"]["TransactionType"]; + /** + * @description Reason for the transaction request, intended to the Payer. + * @example Free-text memo. + */ + note?: string; + /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ + geoCode?: components["schemas"]["GeoCode"]; + /** + * @description OTP or QR Code, otherwise empty. + * @example OTP + */ + authenticationType?: string; + /** + * @description Can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, Merchant to know that their request has a time limit. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration?: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionRequestsIDPutResponse + * @description The object sent in the PUT /transactionRequests/{ID} callback. + */ + TransactionRequestsIDPutResponse: { + /** + * @description Identifies a related transaction (if a transaction has been created). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transactionId?: string; + /** + * @description State of the transaction request. + * @example RECEIVED + */ + transactionRequestState: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * QuotesPostRequest + * @description The object sent in the POST /quotes request. + */ + QuotesPostRequest: { + /** + * @description Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + quoteId: string; + /** + * @description Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. + * @example a8323bc6-c228-4df2-ae82-e5a997baf899 + */ + transactionId: string; + /** + * @description Identifies an optional previously-sent transaction request. + * @example a8323bc6-c228-4df2-ae82-e5a997baf890 + */ + transactionRequestId?: string; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + payer: { + partyIdInfo?: { + /** + * @description Information about the Payer in the proposed financial transaction. Type of the identifier. + * @example PERSONAL_ID + */ + partyIdType?: string; + /** + * @description Information about the Payer in the proposed financial transaction. An indentifier for the Party. + * @example 16135551212 + */ + partyIdentifier?: string; + /** + * @description Information about the Payer in the proposed financial transaction. A sub-identifier or sub-type for the Party. + * @example PASSPORT + */ + partySubIdOrType?: string; + /** + * @description FSP ID (if known). + * @example 1234 + */ + fspId?: string; + }; + /** + * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. + * @example 1234 + */ + merchantClassificationCode?: string; + /** + * @description Display name of the Party, could be a real name or a nick name. + * @example Lars Bergqvist + */ + name?: string; + personalInfo?: { + complexName?: { + /** + * @description Party’s first name. + * @example Lars + */ + firstName?: string; + /** + * @description Party’s middle name. + * @example Per + */ + middleName?: string; + /** + * @description Party’s last name. + * @example Bergqvist + */ + lastName?: string; + }; + /** + * @description Date of birth for the Party. + * @example 1977-07-17 + */ + dateOfBirth?: string; + }; + }; + /** + * @description SEND for send amount, RECEIVE for receive amount. + * @example SEND + */ + amountType: string; + amount: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 123.45 + */ + amount?: string; + }; + fees?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 1.25 + */ + amount?: string; + }; + /** @description Type of transaction for which the quote is requested. */ + transactionType: components["schemas"]["TransactionType"]; + /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ + geoCode?: components["schemas"]["GeoCode"]; + /** + * @description A memo that will be attached to the transaction. + * @example Free-text memo. + */ + note?: string; + /** + * @description Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration?: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + QuotesIDPutResponse: { + transferAmount: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 124.45 + */ + amount?: string; + }; + payeeReceiveAmount?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 123.45 + */ + amount?: string; + }; + payeeFspFee?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 1.45 + */ + amount?: string; + }; + payeeFspCommission?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 0 + */ + amount?: string; + }; + /** + * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + /** @description Longitude and Latitude of the Payee. Can be used to detect fraud. */ + geoCode?: components["schemas"]["GeoCode"]; + /** + * @description The ILP Packet that must be attached to the transfer by the Payer. + * @example “AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA” + */ + ilpPacket: string; + /** + * @description The condition that must be attached to the transfer by the Payer. + * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA + */ + condition: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * AuthorizationsIDPutResponse + * @description The object sent in the PUT /authorizations/{ID} callback. + */ + AuthorizationsIDPutResponse: { + /** + * @description OTP or QR Code if entered, otherwise empty. + * @example OTP + */ + authenticationInfo?: string; + /** + * @description Enum containing response information; if the customer entered the authentication value, rejected the transaction, or requested a resend of the authentication value. + * @example ENTERED + */ + responseType: string; + }; + /** + * TransfersPostRequest + * @description The object sent in the POST /transfers request. + */ + TransfersPostRequest: { + /** + * @description The common ID between the FSPs and the optional Switch for the transfer object, decided by the Payer FSP. The ID should be reused for resends of the same transfer. A new ID should be generated for each new transfer. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transferId: string; + /** + * @description Payee FSP in the proposed financial transaction. + * @example 1234 + */ + payeeFsp: string; + /** + * @description Payer FSP in the proposed financial transaction. + * @example 5678 + */ + payerFsp: string; + /** @description The transfer amount to be sent. */ + amount: components["schemas"]["Money"]; + /** + * @description The ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data. + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + ilpPacket: string; + /** + * @description The condition that must be fulfilled to commit the transfer. + * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA + */ + condition: string; + /** + * @description Expiration can be set to get a quick failure expiration of the transfer. The transfer should be rolled back if no fulfilment is delivered before this time. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransfersIDPutResponse + * @description The object sent in the PUT /transfers/{ID} callback. + */ + TransfersIDPutResponse: { + /** + * @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + fulfilment?: string; + /** + * @description Time and date when the transaction was completed. + * @example 2016-05-24T08:38:08.699-04:00 + */ + completedTimestamp?: string; + /** + * @description State of the transfer. + * @example RESERVED + */ + transferState: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionsIDPutResponse + * @description The object sent in the PUT /transactions/{ID} callback. + */ + TransactionsIDPutResponse: { + /** + * @description Time and date when the transaction was completed. + * @example 2016-05-24T08:38:08.699-04:00 + */ + completedTimestamp?: string; + /** + * @description State of the transaction. + * @example RECEIVED + */ + transactionState: string; + /** + * @description Optional redemption information provided to Payer after transaction has been completed. + * @example Test-Code + */ + code?: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkQuotesPostRequest + * @description The object sent in the POST /bulkQuotes request. + */ + BulkQuotesPostRequest: { + /** + * @description Common ID between the FSPs for the bulk quote object, decided by the Payer FSP. The ID should be reused for resends of the same bulk quote. A new ID should be generated for each new bulk quote. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + bulkQuoteId: string; + payer: { + /** @description Party Id type, id, sub ID or type, and FSP Id. */ + partyIdInfo?: components["schemas"]["PartyIdInfo"]; + /** + * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. + * @example 1234 + */ + merchantClassificationCode?: string; + /** + * @description Display name of the Party, could be a real name or a nick name. + * @example Henrik Karlsson + */ + name?: string; + /** @description Personal information used to verify identity of Party such as first, middle, last name and date of birth. */ + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ + geoCode?: components["schemas"]["GeoCode"]; + /** + * @description Expiration is optional to let the Payee FSP know when a quote no longer needs to be returned. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration?: string; + individualQuotes: { + /** + * @description Identifies quote message. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + quoteId?: string; + /** + * @description Identifies transaction message. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transactionId?: string; + payee?: { + /** @description Party Id type, id, sub ID or type, and FSP Id. */ + partyIdInfo?: components["schemas"]["PartyIdInfo"]; + /** + * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. + * @example 1234 + */ + merchantClassificationCode?: string; + /** + * @description Display name of the Party, could be a real name or a nick name. + * @example Henrik Karlsson + */ + name?: string; + /** @description Personal information used to verify identity of Party such as first, middle, last name and date of birth. */ + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** + * @description SEND for sendAmount, RECEIVE for receiveAmount. + * @example RECEIVE + */ + amountType?: string; + amount?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 123.45 + */ + amount?: string; + }; + fees?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 1.45 + */ + amount?: string; + }; + /** @description Type of transaction that the quote is requested for. */ + transactionType?: components["schemas"]["TransactionType"]; + /** + * @description Memo that will be attached to the transaction. + * @example Note sent to Payee. + */ + note?: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + }; + /** + * IndividualQuoteResult + * @description Data model for the complex type IndividualQuoteResult. + */ + IndividualQuoteResult: { + /** + * @description Identifies the quote message. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + quoteId: string; + /** @description Information about the Payee in the proposed financial transaction. */ + payee?: components["schemas"]["Party"]; + transferAmount?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 124.45 + */ + amount?: string; + }; + payeeReceiveAmount?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 123.45 + */ + amount?: string; + }; + payeeFspFee?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 1.45 + */ + amount?: string; + }; + payeeFspCommission?: { + /** + * @description Currency of the amount. + * @example USD + */ + currency?: string; + /** + * @description Amount of money. + * @example 1.45 + */ + amount?: string; + }; + /** + * @description The ILP Packet that must be attached to the transfer by the Payer. + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + ilpPacket?: string; + /** + * @description The condition that must be attached to the transfer by the Payer. + * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA + */ + condition?: string; + /** @description Error code, category description. **Note:** receiveAmount, payeeFspFee, payeeFspCommission, expiration, ilpPacket, condition should not be set if errorInformation is set. */ + errorInformation?: components["schemas"]["ErrorInformation"]; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkQuotesIDPutResponse + * @description The object sent in the PUT /bulkQuotes/{ID} callback. + */ + BulkQuotesIDPutResponse: { + /** @description Fees for each individual transaction, if any of them are charged per transaction. */ + individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][]; + /** + * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction request. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualTransfer + * @description Data model for the complex type IndividualTransfer. + */ + IndividualTransfer: { + /** + * @description Identifies messages related to the same /transfers sequence. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transferId: string; + /** @description Transaction amount to be sent. */ + transferAmount: components["schemas"]["Money"]; + /** + * @description ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data. + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + ilpPacket: string; + /** + * @description Condition that must be fulfilled to commit the transfer. + * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA + */ + condition: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkTransfersPostRequest + * @description The object sent in the POST /bulkTransfers request. + */ + BulkTransfersPostRequest: { + /** + * @description Common ID between the FSPs and the optional Switch for the bulk transfer object, decided by the Payer FSP. The ID should be reused for resends of the same bulk transfer. A new ID should be generated for each new bulk transfer. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + bulkTransferId: string; /** - * @description Party’s first name. - * @example Lars + * @description ID of the related bulk quote. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 */ - firstName?: string; + bulkQuoteId: string; /** - * @description Party’s middle name. - * @example Per + * @description Payer FSP identifier. + * @example 5678 */ - middleName?: string; + payerFsp: string; /** - * @description Party’s last name. - * @example Bergqvist + * @description Payee FSP identifier. + * @example 1234 */ - lastName?: string; - }; - /** - * @description Date of birth for the Party. - * @example 1977-07-17 - */ - dateOfBirth?: string; + payeeFsp: string; + /** @description List of IndividualTransfer elements. */ + individualTransfers: components["schemas"]["IndividualTransfer"][]; + /** + * @description Expiration time of the transfers. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualTransferResult + * @description Data model for the complex type IndividualTransferResult. + */ + IndividualTransferResult: { + /** + * @description Identifies messages related to the same /transfers sequence. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + transferId: string; + /** + * @description Fulfilment of the condition specified with the transaction. **Note:** Either fulfilment or errorInformation should be set, not both. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + fulfilment?: string; + /** @description If transfer is REJECTED, error information may be provided. **Note:** Either fulfilment or errorInformation should be set, not both. */ + errorInformation?: components["schemas"]["ErrorInformation"]; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkTransfersIDPutResponse + * @description The object sent in the PUT /bulkTransfers/{ID} callback. + */ + BulkTransfersIDPutResponse: { + /** + * @description Time and date when the bulk transaction was completed. + * @example 2016-05-24T08:38:08.699-04:00 + */ + completedTimestamp?: string; + /** @description List of IndividualTransferResult elements. */ + individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; + /** + * @description The state of the bulk transfer. + * @example RECEIVED + */ + bulkTransferState: string; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Method Not Allowed */ + 405: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Acceptable */ + 406: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; }; - }; - /** - * @description SEND for send amount, RECEIVE for receive amount. - * @example SEND - */ - amountType: string; - amount: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 123.45 - */ - amount?: string; - }; - fees?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 1.25 - */ - amount?: string; - }; - /** @description Type of transaction for which the quote is requested. */ - transactionType: components["schemas"]["TransactionType"]; - /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ - geoCode?: components["schemas"]["GeoCode"]; - /** - * @description A memo that will be attached to the transaction. - * @example Free-text memo. - */ - note?: string; - /** - * @description Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration?: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - QuotesIDPutResponse: { - transferAmount: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 124.45 - */ - amount?: string; - }; - payeeReceiveAmount?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 123.45 - */ - amount?: string; - }; - payeeFspFee?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 1.45 - */ - amount?: string; - }; - payeeFspCommission?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 0 - */ - amount?: string; - }; - /** - * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - /** @description Longitude and Latitude of the Payee. Can be used to detect fraud. */ - geoCode?: components["schemas"]["GeoCode"]; - /** - * @description The ILP Packet that must be attached to the transfer by the Payer. - * @example “AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA” - */ - ilpPacket: string; - /** - * @description The condition that must be attached to the transfer by the Payer. - * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA - */ - condition: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * AuthorizationsIDPutResponse - * @description The object sent in the PUT /authorizations/{ID} callback. - */ - AuthorizationsIDPutResponse: { - /** - * @description OTP or QR Code if entered, otherwise empty. - * @example OTP - */ - authenticationInfo?: string; - /** - * @description Enum containing response information; if the customer entered the authentication value, rejected the transaction, or requested a resend of the authentication value. - * @example ENTERED - */ - responseType: string; - }; - /** - * TransfersPostRequest - * @description The object sent in the POST /transfers request. - */ - TransfersPostRequest: { - /** - * @description The common ID between the FSPs and the optional Switch for the transfer object, decided by the Payer FSP. The ID should be reused for resends of the same transfer. A new ID should be generated for each new transfer. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transferId: string; - /** - * @description Payee FSP in the proposed financial transaction. - * @example 1234 - */ - payeeFsp: string; - /** - * @description Payer FSP in the proposed financial transaction. - * @example 5678 - */ - payerFsp: string; - /** @description The transfer amount to be sent. */ - amount: components["schemas"]["Money"]; - /** - * @description The ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data. - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - ilpPacket: string; - /** - * @description The condition that must be fulfilled to commit the transfer. - * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA - */ - condition: string; - /** - * @description Expiration can be set to get a quick failure expiration of the transfer. The transfer should be rolled back if no fulfilment is delivered before this time. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransfersIDPutResponse - * @description The object sent in the PUT /transfers/{ID} callback. - */ - TransfersIDPutResponse: { - /** - * @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - fulfilment?: string; - /** - * @description Time and date when the transaction was completed. - * @example 2016-05-24T08:38:08.699-04:00 - */ - completedTimestamp?: string; - /** - * @description State of the transfer. - * @example RESERVED - */ - transferState: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionsIDPutResponse - * @description The object sent in the PUT /transactions/{ID} callback. - */ - TransactionsIDPutResponse: { - /** - * @description Time and date when the transaction was completed. - * @example 2016-05-24T08:38:08.699-04:00 - */ - completedTimestamp?: string; - /** - * @description State of the transaction. - * @example RECEIVED - */ - transactionState: string; - /** - * @description Optional redemption information provided to Payer after transaction has been completed. - * @example Test-Code - */ - code?: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkQuotesPostRequest - * @description The object sent in the POST /bulkQuotes request. - */ - BulkQuotesPostRequest: { - /** - * @description Common ID between the FSPs for the bulk quote object, decided by the Payer FSP. The ID should be reused for resends of the same bulk quote. A new ID should be generated for each new bulk quote. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - bulkQuoteId: string; - payer: { - /** @description Party Id type, id, sub ID or type, and FSP Id. */ - partyIdInfo?: components["schemas"]["PartyIdInfo"]; - /** - * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. - * @example 1234 - */ - merchantClassificationCode?: string; - /** - * @description Display name of the Party, could be a real name or a nick name. - * @example Henrik Karlsson - */ - name?: string; - /** @description Personal information used to verify identity of Party such as first, middle, last name and date of birth. */ - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ - geoCode?: components["schemas"]["GeoCode"]; - /** - * @description Expiration is optional to let the Payee FSP know when a quote no longer needs to be returned. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration?: string; - individualQuotes: { - /** - * @description Identifies quote message. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - quoteId?: string; - /** - * @description Identifies transaction message. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transactionId?: string; - payee?: { - /** @description Party Id type, id, sub ID or type, and FSP Id. */ - partyIdInfo?: components["schemas"]["PartyIdInfo"]; - /** - * @description Used in the context of Payee Information, where the Payee happens to be a merchant accepting merchant payments. - * @example 1234 - */ - merchantClassificationCode?: string; - /** - * @description Display name of the Party, could be a real name or a nick name. - * @example Henrik Karlsson - */ - name?: string; - /** @description Personal information used to verify identity of Party such as first, middle, last name and date of birth. */ - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** - * @description SEND for sendAmount, RECEIVE for receiveAmount. - * @example RECEIVE - */ - amountType?: string; - amount?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 123.45 - */ - amount?: string; - }; - fees?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 1.45 - */ - amount?: string; - }; - /** @description Type of transaction that the quote is requested for. */ - transactionType?: components["schemas"]["TransactionType"]; - /** - * @description Memo that will be attached to the transaction. - * @example Note sent to Payee. - */ - note?: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - }; - /** - * IndividualQuoteResult - * @description Data model for the complex type IndividualQuoteResult. - */ - IndividualQuoteResult: { - /** - * @description Identifies the quote message. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - quoteId: string; - /** @description Information about the Payee in the proposed financial transaction. */ - payee?: components["schemas"]["Party"]; - transferAmount?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 124.45 - */ - amount?: string; - }; - payeeReceiveAmount?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 123.45 - */ - amount?: string; - }; - payeeFspFee?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 1.45 - */ - amount?: string; - }; - payeeFspCommission?: { - /** - * @description Currency of the amount. - * @example USD - */ - currency?: string; - /** - * @description Amount of money. - * @example 1.45 - */ - amount?: string; - }; - /** - * @description The ILP Packet that must be attached to the transfer by the Payer. - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - ilpPacket?: string; - /** - * @description The condition that must be attached to the transfer by the Payer. - * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA - */ - condition?: string; - /** @description Error code, category description. **Note:** receiveAmount, payeeFspFee, payeeFspCommission, expiration, ilpPacket, condition should not be set if errorInformation is set. */ - errorInformation?: components["schemas"]["ErrorInformation"]; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkQuotesIDPutResponse - * @description The object sent in the PUT /bulkQuotes/{ID} callback. - */ - BulkQuotesIDPutResponse: { - /** @description Fees for each individual transaction, if any of them are charged per transaction. */ - individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][]; - /** - * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction request. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualTransfer - * @description Data model for the complex type IndividualTransfer. - */ - IndividualTransfer: { - /** - * @description Identifies messages related to the same /transfers sequence. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transferId: string; - /** @description Transaction amount to be sent. */ - transferAmount: components["schemas"]["Money"]; - /** - * @description ILP Packet containing the amount delivered to the Payee and the ILP Address of the Payee and any other end-to-end data. - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - ilpPacket: string; - /** - * @description Condition that must be fulfilled to commit the transfer. - * @example f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA - */ - condition: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkTransfersPostRequest - * @description The object sent in the POST /bulkTransfers request. - */ - BulkTransfersPostRequest: { - /** - * @description Common ID between the FSPs and the optional Switch for the bulk transfer object, decided by the Payer FSP. The ID should be reused for resends of the same bulk transfer. A new ID should be generated for each new bulk transfer. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - bulkTransferId: string; - /** - * @description ID of the related bulk quote. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - bulkQuoteId: string; - /** - * @description Payer FSP identifier. - * @example 5678 - */ - payerFsp: string; - /** - * @description Payee FSP identifier. - * @example 1234 - */ - payeeFsp: string; - /** @description List of IndividualTransfer elements. */ - individualTransfers: components["schemas"]["IndividualTransfer"][]; - /** - * @description Expiration time of the transfers. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualTransferResult - * @description Data model for the complex type IndividualTransferResult. - */ - IndividualTransferResult: { - /** - * @description Identifies messages related to the same /transfers sequence. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - transferId: string; - /** - * @description Fulfilment of the condition specified with the transaction. **Note:** Either fulfilment or errorInformation should be set, not both. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - fulfilment?: string; - /** @description If transfer is REJECTED, error information may be provided. **Note:** Either fulfilment or errorInformation should be set, not both. */ - errorInformation?: components["schemas"]["ErrorInformation"]; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkTransfersIDPutResponse - * @description The object sent in the PUT /bulkTransfers/{ID} callback. - */ - BulkTransfersIDPutResponse: { - /** - * @description Time and date when the bulk transaction was completed. - * @example 2016-05-24T08:38:08.699-04:00 - */ - completedTimestamp?: string; - /** @description List of IndividualTransferResult elements. */ - individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; - /** - * @description The state of the bulk transfer. - * @example RECEIVED - */ - bulkTransferState: string; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - /** @description Accepted */ - 202: { - content: never; - }; - /** @description Bad Request */ - 400: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Method Not Allowed */ - 405: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Acceptable */ - 406: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Implemented */ - 501: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Service Unavailable */ - 503: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - }; - parameters: { - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - Type: string; - /** @description The identifier value. */ - ID: string; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - /** @description The `Date` header field indicates the date when the request was sent. */ - Date: string; - /** - * @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. - * - * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. - */ - "X-Forwarded-For"?: string; - /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ - "FSPIOP-Source": string; - /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ - "FSPIOP-Destination"?: string; - /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ - "FSPIOP-Encryption"?: string; - /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ - "FSPIOP-Signature"?: string; - /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-URI"?: string; - /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-HTTP-Method"?: string; - /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ - Accept: string; - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length"?: number; - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - SubId: string; - }; - requestBodies: never; - headers: { - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length": number; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - }; - pathItems: never; + /** @description Not Implemented */ + 501: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Service Unavailable */ + 503: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + }; + parameters: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The identifier value. */ + ID: string; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: string; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For": string; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": string; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination": string; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption": string; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature": string; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI": string; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method": string; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: string; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: string; + }; + requestBodies: never; + headers: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + }; + pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - - /** @description Essential path to include schema components that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */ - Interface: { - requestBody?: { - content: { - "application/json": components["schemas"]["Amount"] | components["schemas"]["AmountType"] | components["schemas"]["AuthenticationInfo"] | components["schemas"]["AuthenticationType"] | components["schemas"]["AuthenticationValue"] | components["schemas"]["AuthorizationResponse"] | components["schemas"]["BalanceOfPayments"] | components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["BulkTransferState"] | components["schemas"]["Code"] | components["schemas"]["CorrelationId"] | components["schemas"]["Currency"] | components["schemas"]["Date"] | components["schemas"]["DateOfBirth"] | components["schemas"]["DateTime"] | components["schemas"]["ErrorCode"] | components["schemas"]["ErrorDescription"] | components["schemas"]["ExtensionKey"] | components["schemas"]["ExtensionValue"] | components["schemas"]["FirstName"] | components["schemas"]["FspId"] | components["schemas"]["IlpCondition"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["IlpPacket"] | components["schemas"]["IndividualQuote"] | components["schemas"]["Integer"] | components["schemas"]["LastName"] | components["schemas"]["Latitude"] | components["schemas"]["Longitude"] | components["schemas"]["MerchantClassificationCode"] | components["schemas"]["MiddleName"] | components["schemas"]["Name"] | components["schemas"]["Note"] | components["schemas"]["OtpValue"] | components["schemas"]["PartyIdentifier"] | components["schemas"]["PartyIdType"] | components["schemas"]["PartyName"] | components["schemas"]["PartySubIdOrType"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["RefundReason"] | components["schemas"]["QRCODE"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["TransactionInitiator"] | components["schemas"]["TransactionInitiatorType"] | components["schemas"]["TransactionRequestState"] | components["schemas"]["TransactionScenario"] | components["schemas"]["TransactionState"] | components["schemas"]["TransactionSubScenario"] | components["schemas"]["TransferState"] | components["schemas"]["UndefinedEnum"]; - }; + Interface: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["Amount"] | components["schemas"]["AmountType"] | components["schemas"]["AuthenticationInfo"] | components["schemas"]["AuthenticationType"] | components["schemas"]["AuthenticationValue"] | components["schemas"]["AuthorizationResponse"] | components["schemas"]["BalanceOfPayments"] | components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["BulkTransferState"] | components["schemas"]["Code"] | components["schemas"]["CorrelationId"] | components["schemas"]["Currency"] | components["schemas"]["Date"] | components["schemas"]["DateOfBirth"] | components["schemas"]["DateTime"] | components["schemas"]["ErrorCode"] | components["schemas"]["ErrorDescription"] | components["schemas"]["ExtensionKey"] | components["schemas"]["ExtensionValue"] | components["schemas"]["FirstName"] | components["schemas"]["FspId"] | components["schemas"]["IlpCondition"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["IlpPacket"] | components["schemas"]["IndividualQuote"] | components["schemas"]["Integer"] | components["schemas"]["LastName"] | components["schemas"]["Latitude"] | components["schemas"]["Longitude"] | components["schemas"]["MerchantClassificationCode"] | components["schemas"]["MiddleName"] | components["schemas"]["Name"] | components["schemas"]["Note"] | components["schemas"]["OtpValue"] | components["schemas"]["PartyIdentifier"] | components["schemas"]["PartyIdType"] | components["schemas"]["PartyName"] | components["schemas"]["PartySubIdOrType"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["RefundReason"] | components["schemas"]["QRCODE"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["TransactionInitiator"] | components["schemas"]["TransactionInitiatorType"] | components["schemas"]["TransactionRequestState"] | components["schemas"]["TransactionScenario"] | components["schemas"]["TransactionState"] | components["schemas"]["TransactionSubScenario"] | components["schemas"]["TransferState"] | components["schemas"]["UndefinedEnum"]; + }; + }; + responses: { + /** @description Ok */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; }; - responses: { - /** @description Ok */ - 200: { - content: never; - }; - }; - }; - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; + ParticipantsByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; + ParticipantsByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). - */ - ParticipantsByIDAndType: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; + ParticipantsByIDAndType: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; + ParticipantsByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + ParticipantsErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsSubIdByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; + ParticipantsSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsSubIdByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; + ParticipantsSubIdByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). - */ - ParticipantsSubIdByTypeAndIDPost: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; + ParticipantsSubIdByTypeAndIDPost: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsSubIdByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; + ParticipantsSubIdByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsSubIdErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + ParticipantsSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - Participants1: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsPostRequest"]; - }; + Participants1: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - putParticipantsByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsIDPutResponse"]; - }; + putParticipantsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - ParticipantsByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + ParticipantsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - PartiesByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; + PartiesByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - PartiesByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Party information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; - }; + PartiesByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. - */ - PartiesErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + PartiesErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - PartiesSubIdByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; + PartiesSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - PartiesSubIdByTypeAndIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Party information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; - }; + PartiesSubIdByTypeAndIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. - */ - PartiesSubIdErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + PartiesSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform transaction request - * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. - */ - TransactionRequests: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Transaction request to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionRequestsPostRequest"]; - }; + TransactionRequests: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Transaction request to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionRequestsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transaction request information - * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. - */ - TransactionRequestsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + TransactionRequestsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction request information - * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - TransactionRequestsByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transaction request information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionRequestsIDPutResponse"]; - }; + TransactionRequestsByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transaction request information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionRequestsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction request information error - * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - TransactionRequestsErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + TransactionRequestsErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate quote - * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. - */ - Quotes: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["QuotesPostRequest"]; - }; + Quotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["QuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve quote information - * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. - */ - QuotesByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + QuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return quote information - * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - QuotesByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["QuotesIDPutResponse"]; - }; + QuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["QuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return quote information error - * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - QuotesByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + QuotesByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform authorization - * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* - * - * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. - * - * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. - * - * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. - * - * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. - * - * The following is an example URI containing all the required key-value pairs in the query string*:* - * - * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` - */ - AuthorizationsByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + AuthorizationsByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return authorization result - * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. - */ - AuthorizationsByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Authorization result returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["AuthorizationsIDPutResponse"]; - }; + AuthorizationsByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Authorization result returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["AuthorizationsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return authorization error - * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. - */ - AuthorizationsByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + AuthorizationsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform transfer - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. - */ - transfers: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersPostRequest"]; - }; + transfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transfer information - * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. - */ - TransfersByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + TransfersByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information - * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. - */ - TransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersIDPutResponse"]; - }; + TransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information error - * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. - */ - TransfersByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + TransfersByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transaction information - * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). - */ - TransactionsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + TransactionsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction information - * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - TransactionsByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transaction information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionsIDPutResponse"]; - }; + TransactionsByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transaction information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction information error - * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - TransactionsErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + TransactionsErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate bulk quote - * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. - */ - BulkQuotes: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the bulk quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkQuotesPostRequest"]; - }; + BulkQuotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the bulk quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkQuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve bulk quote information - * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. - */ - BulkQuotesByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + BulkQuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk quote information - * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - BulkQuotesByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Bulk quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkQuotesIDPutResponse"]; - }; + BulkQuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Bulk quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkQuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk quote information error - * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - BulkQuotesErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + BulkQuotesErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform bulk transfer - * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. - */ - BulkTransfers: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the bulk transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkTransfersPostRequest"]; - }; + BulkTransfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the bulk transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkTransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve bulk transfer information - * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. - */ - BulkTransferByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + BulkTransferByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk transfer information - * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - BulkTransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Bulk transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkTransfersIDPutResponse"]; - }; + BulkTransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Bulk transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkTransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk transfer information error - * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - BulkTransfersErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + BulkTransfersErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field should be set by the original sender of the request (if known), so that any entities between the client and the server do not need to parse the payload for routing purposes. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; } diff --git a/src/fspiop/v1_1/openapi.ts b/src/fspiop/v1_1/openapi.ts index 557f9ec6..b871da69 100644 --- a/src/fspiop/v1_1/openapi.ts +++ b/src/fspiop/v1_1/openapi.ts @@ -3,3193 +3,4264 @@ * Do not make direct changes to the file. */ - export interface paths { - "/participants/{Type}/{ID}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - post: operations["ParticipantsByIDAndType"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants/{Type}/{ID}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsErrorByTypeAndID"]; - }; - "/participants/{Type}/{ID}/{SubId}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsSubIdByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsSubIdByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - post: operations["ParticipantsSubIdByTypeAndIDPost"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsSubIdByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/participants/{Type}/{ID}/{SubId}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsSubIdErrorByTypeAndID"]; - }; - "/participants": { - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - post: operations["Participants1"]; - }; - "/participants/{ID}": { - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - put: operations["putParticipantsByID"]; - }; - "/participants/{ID}/error": { - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - put: operations["ParticipantsByIDAndError"]; - }; - "/parties/{Type}/{ID}": { - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - get: operations["PartiesByTypeAndID"]; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - put: operations["PartiesByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/parties/{Type}/{ID}/error": { - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. - */ - put: operations["PartiesErrorByTypeAndID"]; - }; - "/parties/{Type}/{ID}/{SubId}": { - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - get: operations["PartiesSubIdByTypeAndID"]; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - put: operations["PartiesSubIdByTypeAndIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/parties/{Type}/{ID}/{SubId}/error": { - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["PartiesSubIdErrorByTypeAndID"]; - }; - "/transactionRequests": { - /** - * Perform transaction request - * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. - */ - post: operations["TransactionRequests"]; - }; - "/transactionRequests/{ID}": { - /** - * Retrieve transaction request information - * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. - */ - get: operations["TransactionRequestsByID"]; - /** - * Return transaction request information - * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - put: operations["TransactionRequestsByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transactionRequests/{ID}/error": { - /** - * Return transaction request information error - * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - put: operations["TransactionRequestsErrorByID"]; - }; - "/quotes": { - /** - * Calculate quote - * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. - */ - post: operations["Quotes"]; - }; - "/quotes/{ID}": { - /** - * Retrieve quote information - * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. - */ - get: operations["QuotesByID"]; - /** - * Return quote information - * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - put: operations["QuotesByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/quotes/{ID}/error": { - /** - * Return quote information error - * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - put: operations["QuotesByIDAndError"]; - }; - "/authorizations/{ID}": { - /** - * Perform authorization - * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* - * - * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. - * - * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. - * - * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. - * - * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. - * - * The following is an example URI containing all the required key-value pairs in the query string*:* - * - * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` - */ - get: operations["AuthorizationsByIDGet"]; - /** - * Return authorization result - * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. - */ - put: operations["AuthorizationsByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/authorizations/{ID}/error": { - /** - * Return authorization error - * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. - */ - put: operations["AuthorizationsByIDAndError"]; - }; - "/transfers": { - /** - * Perform transfer - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. - */ - post: operations["transfers"]; - }; - "/transfers/{ID}": { - /** - * Retrieve transfer information - * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. - */ - get: operations["TransfersByIDGet"]; - /** - * Return transfer information - * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. - */ - put: operations["TransfersByIDPut"]; - /** - * Return transfer information - * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. - */ - patch: operations["TransfersByIDPatch"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transfers/{ID}/error": { - /** - * Return transfer information error - * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. - */ - put: operations["TransfersByIDAndError"]; - }; - "/transactions/{ID}": { - /** - * Retrieve transaction information - * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). - */ - get: operations["TransactionsByID"]; - /** - * Return transaction information - * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - put: operations["TransactionsByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transactions/{ID}/error": { - /** - * Return transaction information error - * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - put: operations["TransactionsErrorByID"]; - }; - "/bulkQuotes": { - /** - * Calculate bulk quote - * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. - */ - post: operations["BulkQuotes"]; - }; - "/bulkQuotes/{ID}": { - /** - * Retrieve bulk quote information - * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. - */ - get: operations["BulkQuotesByID"]; - /** - * Return bulk quote information - * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - put: operations["BulkQuotesByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/bulkQuotes/{ID}/error": { - /** - * Return bulk quote information error - * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - put: operations["BulkQuotesErrorByID"]; - }; - "/bulkTransfers": { - /** - * Perform bulk transfer - * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. - */ - post: operations["BulkTransfers"]; - }; - "/bulkTransfers/{ID}": { - /** - * Retrieve bulk transfer information - * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. - */ - get: operations["BulkTransferByID"]; - /** - * Return bulk transfer information - * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - put: operations["BulkTransfersByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/bulkTransfers/{ID}/error": { - /** - * Return bulk transfer information error - * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - put: operations["BulkTransfersErrorByID"]; - }; + "/participants/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 + */ + post: operations["ParticipantsByIDAndType"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsSubIdByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsSubIdByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 + */ + post: operations["ParticipantsSubIdByTypeAndIDPost"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsSubIdByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create bulk participant information + * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. + */ + post: operations["Participants1"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information + * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. + */ + put: operations["putParticipantsByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information error + * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. + */ + put: operations["ParticipantsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesByTypeAndID2"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. + */ + put: operations["PartiesErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesSubIdByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesSubIdByTypeAndIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["PartiesSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transaction request + * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. + */ + post: operations["TransactionRequests"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transaction request information + * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. + */ + get: operations["TransactionRequestsByID"]; + /** + * Return transaction request information + * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. + */ + put: operations["TransactionRequestsByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transaction request information error + * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. + */ + put: operations["TransactionRequestsErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate quote + * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. + */ + post: operations["Quotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve quote information + * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. + */ + get: operations["QuotesByID"]; + /** + * Return quote information + * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return quote information error + * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/authorizations/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Perform authorization + * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* + * + * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. + * + * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. + * + * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. + * + * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. + * + * The following is an example URI containing all the required key-value pairs in the query string*:* + * + * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` + */ + get: operations["AuthorizationsByIDGet"]; + /** + * Return authorization result + * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. + */ + put: operations["AuthorizationsByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/authorizations/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return authorization error + * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. + */ + put: operations["AuthorizationsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transfer + * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. + */ + post: operations["transfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transfer information + * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. + */ + get: operations["TransfersByIDGet"]; + /** + * Return transfer information + * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. + */ + put: operations["TransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Return transfer information + * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. + */ + patch: operations["TransfersByIDPatch"]; + trace?: never; + }; + "/transfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transfer information error + * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. + */ + put: operations["TransfersByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transaction information + * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). + */ + get: operations["TransactionsByID"]; + /** + * Return transaction information + * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. + */ + put: operations["TransactionsByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transaction information error + * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. + */ + put: operations["TransactionsErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate bulk quote + * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. + */ + post: operations["BulkQuotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve bulk quote information + * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. + */ + get: operations["BulkQuotesByID"]; + /** + * Return bulk quote information + * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. + */ + put: operations["BulkQuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk quote information error + * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. + */ + put: operations["BulkQuotesErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform bulk transfer + * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. + */ + post: operations["BulkTransfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve bulk transfer information + * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. + */ + get: operations["BulkTransferByID"]; + /** + * Return bulk transfer information + * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. + */ + put: operations["BulkTransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk transfer information error + * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. + */ + put: operations["BulkTransfersErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * AuthenticationInfo - * @description Data model for the complex type AuthenticationInfo. - */ - AuthenticationInfo: { - authentication: components["schemas"]["AuthenticationType"]; - authenticationValue: components["schemas"]["AuthenticationValue"]; - }; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * - U2F - U2F is a new addition isolated to Thirdparty stream. - * @example OTP - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE" | "U2F"; - /** - * AuthenticationValue - * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. - */ - AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"]; - /** - * AuthorizationResponse - * @description Below are the allowed values for the enumeration. - * - ENTERED - Consumer entered the authentication value. - * - REJECTED - Consumer rejected the transaction. - * - RESEND - Consumer requested to resend the authentication value. - * @example ENTERED - * @enum {string} - */ - AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND"; - /** - * AuthorizationsIDPutResponse - * @description The object sent in the PUT /authorizations/{ID} callback. - */ - AuthorizationsIDPutResponse: { - authenticationInfo?: components["schemas"]["AuthenticationInfo"]; - responseType: components["schemas"]["AuthorizationResponse"]; - }; - /** - * BalanceOfPayments - * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. - * @example 123 - */ - BalanceOfPayments: string; - /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ - BinaryString: string; - /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */ - BinaryString32: string; - /** - * BulkQuotesIDPutResponse - * @description The object sent in the PUT /bulkQuotes/{ID} callback. - */ - BulkQuotesIDPutResponse: { - /** @description Fees for each individual transaction, if any of them are charged per transaction. */ - individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkQuotesPostRequest - * @description The object sent in the POST /bulkQuotes request. - */ - BulkQuotesPostRequest: { - bulkQuoteId: components["schemas"]["CorrelationId"]; - payer: components["schemas"]["Party"]; - geoCode?: components["schemas"]["GeoCode"]; - expiration?: components["schemas"]["DateTime"]; - /** @description List of quotes elements. */ - individualQuotes: components["schemas"]["IndividualQuote"][]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkTransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP. - * - PENDING - Payee FSP has validated the bulk transfer. - * - ACCEPTED - Payee FSP has accepted to process the bulk transfer. - * - PROCESSING - Payee FSP has started to transfer fund to the Payees. - * - COMPLETED - Payee FSP has completed transfer of funds to the Payees. - * - REJECTED - Payee FSP has rejected to process the bulk transfer. - * @example RECEIVED - * @enum {string} - */ - BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED"; - /** - * BulkTransfersIDPutResponse - * @description The object sent in the PUT /bulkTransfers/{ID} callback. - */ - BulkTransfersIDPutResponse: { - completedTimestamp?: components["schemas"]["DateTime"]; - /** @description List of IndividualTransferResult elements. */ - individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; - bulkTransferState: components["schemas"]["BulkTransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkTransfersPostRequest - * @description The object sent in the POST /bulkTransfers request. - */ - BulkTransfersPostRequest: { - bulkTransferId: components["schemas"]["CorrelationId"]; - bulkQuoteId: components["schemas"]["CorrelationId"]; - payerFsp: components["schemas"]["FspId"]; - payeeFsp: components["schemas"]["FspId"]; - /** @description List of IndividualTransfer elements. */ - individualTransfers: components["schemas"]["IndividualTransfer"][]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Code - * @description Any code/token returned by the Payee FSP (TokenCode Type). - * @example Test-Code - */ - Code: string; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** - * Date - * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”. - */ - Date: string; - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ErrorInformationObject - * @description Data model for the complex type object that contains ErrorInformation. - */ - ErrorInformationObject: { - errorInformation: components["schemas"]["ErrorInformation"]; - }; - /** - * ErrorInformationResponse - * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. - */ - ErrorInformationResponse: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IndividualQuote - * @description Data model for the complex type IndividualQuote. - */ - IndividualQuote: { - quoteId: components["schemas"]["CorrelationId"]; - transactionId: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - amountType: components["schemas"]["AmountType"]; - amount: components["schemas"]["Money"]; - fees?: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - note?: components["schemas"]["Note"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualQuoteResult - * @description Data model for the complex type IndividualQuoteResult. - */ - IndividualQuoteResult: { - quoteId: components["schemas"]["CorrelationId"]; - payee?: components["schemas"]["Party"]; - transferAmount?: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - ilpPacket?: components["schemas"]["IlpPacket"]; - condition?: components["schemas"]["IlpCondition"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualTransfer - * @description Data model for the complex type IndividualTransfer. - */ - IndividualTransfer: { - transferId: components["schemas"]["CorrelationId"]; - transferAmount: components["schemas"]["Money"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualTransferResult - * @description Data model for the complex type IndividualTransferResult. - */ - IndividualTransferResult: { - transferId: components["schemas"]["CorrelationId"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Integer - * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. - */ - Integer: string; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * Name - * @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. - * - * 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 ( ). - * - * **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. - */ - Name: string; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * OtpValue - * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed. - */ - OtpValue: string; - /** - * ParticipantsIDPutResponse - * @description The object sent in the PUT /participants/{ID} callback. - */ - ParticipantsIDPutResponse: { - /** @description List of PartyResult elements that were either created or failed to be created. */ - partyList: components["schemas"]["PartyResult"][]; - currency?: components["schemas"]["Currency"]; - }; - /** - * ParticipantsPostRequest - * @description The object sent in the POST /participants request. - */ - ParticipantsPostRequest: { - requestId: components["schemas"]["CorrelationId"]; - /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */ - partyList: components["schemas"]["PartyIdInfo"][]; - currency?: components["schemas"]["Currency"]; - }; - /** - * ParticipantsTypeIDPutResponse - * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. - */ - ParticipantsTypeIDPutResponse: { - fspId?: components["schemas"]["FspId"]; - }; - /** - * ParticipantsTypeIDSubIDPostRequest - * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes. - */ - ParticipantsTypeIDSubIDPostRequest: { - fspId: components["schemas"]["FspId"]; - currency?: components["schemas"]["Currency"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartiesTypeIDPutResponse - * @description The object sent in the PUT /parties/{Type}/{ID} callback. - */ - PartiesTypeIDPutResponse: { - party: components["schemas"]["Party"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - }; - /** - * PartyResult - * @description Data model for the complex type PartyResult. - */ - PartyResult: { - partyId: components["schemas"]["PartyIdInfo"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * PersonalIdentifierType - * @description Below are the allowed values for the enumeration. - * - PASSPORT - A passport number is used as reference to a Party. - * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party. - * - DRIVING_LICENSE - A driving license is used as reference to a Party. - * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party. - * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party. - * - EMPLOYER_ID - A tax identification number is used as reference to a Party. - * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party. - * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party. - * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party. - * - HEALTH_CARD - A health card number is used as reference to a Party. - * - VOTERS_ID - A voter’s identification number is used as reference to a Party. - * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party. - * - OTHER_ID - Any other type of identification type number is used as reference to a Party. - * @enum {string} - */ - PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID"; - /** - * QRCODE - * @description QR code used as a One Time Password. - */ - QRCODE: string; - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - QuotesIDPutResponse: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - expiration: components["schemas"]["DateTime"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * QuotesPostRequest - * @description The object sent in the POST /quotes request. - */ - QuotesPostRequest: { - quoteId: components["schemas"]["CorrelationId"]; - transactionId: components["schemas"]["CorrelationId"]; - transactionRequestId?: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - amountType: components["schemas"]["AmountType"]; - amount: components["schemas"]["Money"]; - fees?: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - geoCode?: components["schemas"]["GeoCode"]; - note?: components["schemas"]["Note"]; - expiration?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Refund - * @description Data model for the complex type Refund. - */ - Refund: { - originalTransactionId: components["schemas"]["CorrelationId"]; - refundReason?: components["schemas"]["RefundReason"]; - }; - /** - * RefundReason - * @description Reason for the refund. - * @example Free text indicating reason for the refund. - */ - RefundReason: string; - /** - * TokenCode - * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z. - */ - TokenCode: string; - /** - * Transaction - * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request. - */ - Transaction: { - transactionId: components["schemas"]["CorrelationId"]; - quoteId: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - amount: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - note?: components["schemas"]["Note"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionInitiator - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * @example PAYEE - * @enum {string} - */ - TransactionInitiator: "PAYER" | "PAYEE"; - /** - * TransactionInitiatorType - * @description Below are the allowed values for the enumeration. - * - CONSUMER - Consumer is the initiator of the transaction. - * - AGENT - Agent is the initiator of the transaction. - * - BUSINESS - Business is the initiator of the transaction. - * - DEVICE - Device is the initiator of the transaction. - * @example CONSUMER - * @enum {string} - */ - TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** - * TransactionRequestState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. - * - PENDING - Payer FSP has sent the transaction request to the Payer. - * - ACCEPTED - Payer has approved the transaction. - * - REJECTED - Payer has rejected the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * TransactionRequestsIDPutResponse - * @description The object sent in the PUT /transactionRequests/{ID} callback. - */ - TransactionRequestsIDPutResponse: { - transactionId?: components["schemas"]["CorrelationId"]; - transactionRequestState: components["schemas"]["TransactionRequestState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionRequestsPostRequest - * @description The object sent in the POST /transactionRequests request. - */ - TransactionRequestsPostRequest: { - transactionRequestId: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["PartyIdInfo"]; - amount: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - note?: components["schemas"]["Note"]; - geoCode?: components["schemas"]["GeoCode"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - expiration?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionScenario - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. - * - 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. - * - REFUND - Used for performing a refund of transaction. - * @example DEPOSIT - * @enum {string} - */ - TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; - /** - * TransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. - * - PENDING - Payee FSP has validated the transaction. - * - COMPLETED - Payee FSP has successfully performed the transaction. - * - REJECTED - Payee FSP has failed to perform the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - /** - * TransactionType - * @description Data model for the complex type TransactionType. - */ - TransactionType: { - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - refundInfo?: components["schemas"]["Refund"]; - balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; - }; - /** - * TransactionsIDPutResponse - * @description The object sent in the PUT /transactions/{ID} callback. - */ - TransactionsIDPutResponse: { - completedTimestamp?: components["schemas"]["DateTime"]; - transactionState: components["schemas"]["TransactionState"]; - code?: components["schemas"]["Code"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @example RESERVED - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** - * TransfersIDPatchResponse - * @description PATCH /transfers/{ID} object - */ - TransfersIDPatchResponse: { - completedTimestamp: components["schemas"]["DateTime"]; - transferState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransfersIDPutResponse - * @description The object sent in the PUT /transfers/{ID} callback. - */ - TransfersIDPutResponse: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - completedTimestamp?: components["schemas"]["DateTime"]; - transferState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransfersPostRequest - * @description The object sent in the POST /transfers request. - */ - TransfersPostRequest: { - transferId: components["schemas"]["CorrelationId"]; - payeeFsp: components["schemas"]["FspId"]; - payerFsp: components["schemas"]["FspId"]; - amount: components["schemas"]["Money"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * U2FPIN - * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. - */ - U2FPIN: string; - /** - * U2FPinValue - * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. - */ - U2FPinValue: { - /** @description U2F challenge-response. */ - pinValue: components["schemas"]["U2FPIN"]; - /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */ - counter: components["schemas"]["Integer"]; - }; - /** - * UndefinedEnum - * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_). - */ - UndefinedEnum: string; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - /** @description Accepted */ - 202: { - content: never; - }; - /** @description Bad Request */ - 400: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Method Not Allowed */ - 405: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Acceptable */ - 406: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Implemented */ - 501: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Service Unavailable */ - 503: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - }; - parameters: { - /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ - Accept: string; - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length"?: number; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - /** @description The `Date` header field indicates the date when the request was sent. */ - Date: string; - /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ - "FSPIOP-Destination"?: string; - /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ - "FSPIOP-Encryption"?: string; - /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-HTTP-Method"?: string; - /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ - "FSPIOP-Signature"?: string; - /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ - "FSPIOP-Source": string; - /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-URI"?: string; - /** @description The identifier value. */ - ID: string; - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - SubId: string; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - Type: string; - /** - * @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. - * - * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. - */ - "X-Forwarded-For"?: string; - }; - requestBodies: never; - headers: { - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length": number; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - }; - pathItems: never; -} - -export type $defs = Record; - -export type external = Record; - -export interface operations { - - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - ParticipantsByIDAndType: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsSubIdByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsSubIdByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - ParticipantsSubIdByTypeAndIDPost: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsSubIdByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsSubIdErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - Participants1: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - putParticipantsByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - ParticipantsByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - PartiesByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - PartiesByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Party information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. - */ - PartiesErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - PartiesSubIdByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - PartiesSubIdByTypeAndIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Party information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. - */ - PartiesSubIdErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform transaction request - * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. - */ - TransactionRequests: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Transaction request to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionRequestsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transaction request information - * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. - */ - TransactionRequestsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction request information - * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - TransactionRequestsByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transaction request information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionRequestsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction request information error - * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - TransactionRequestsErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate quote - * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. - */ - Quotes: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["QuotesPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve quote information - * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. - */ - QuotesByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return quote information - * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - QuotesByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["QuotesIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return quote information error - * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - QuotesByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform authorization - * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* - * - * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. - * - * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. - * - * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. - * - * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. - * - * The following is an example URI containing all the required key-value pairs in the query string*:* - * - * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` - */ - AuthorizationsByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return authorization result - * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. - */ - AuthorizationsByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Authorization result returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["AuthorizationsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return authorization error - * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. - */ - AuthorizationsByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform transfer - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. - */ - transfers: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transfer information - * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. - */ - TransfersByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + schemas: { + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * AuthenticationInfo + * @description Data model for the complex type AuthenticationInfo. + */ + AuthenticationInfo: { + authentication: components["schemas"]["AuthenticationType"]; + authenticationValue: components["schemas"]["AuthenticationValue"]; + }; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * - U2F - U2F is a new addition isolated to Thirdparty stream. + * @example OTP + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE" | "U2F"; + /** + * AuthenticationValue + * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. + */ + AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"]; + /** + * AuthorizationResponse + * @description Below are the allowed values for the enumeration. + * - ENTERED - Consumer entered the authentication value. + * - REJECTED - Consumer rejected the transaction. + * - RESEND - Consumer requested to resend the authentication value. + * @example ENTERED + * @enum {string} + */ + AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND"; + /** + * AuthorizationsIDPutResponse + * @description The object sent in the PUT /authorizations/{ID} callback. + */ + AuthorizationsIDPutResponse: { + authenticationInfo?: components["schemas"]["AuthenticationInfo"]; + responseType: components["schemas"]["AuthorizationResponse"]; + }; + /** + * BalanceOfPayments + * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. + * @example 123 + */ + BalanceOfPayments: string; + /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ + BinaryString: string; + /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */ + BinaryString32: string; + /** + * BulkQuotesIDPutResponse + * @description The object sent in the PUT /bulkQuotes/{ID} callback. + */ + BulkQuotesIDPutResponse: { + /** @description Fees for each individual transaction, if any of them are charged per transaction. */ + individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkQuotesPostRequest + * @description The object sent in the POST /bulkQuotes request. + */ + BulkQuotesPostRequest: { + bulkQuoteId: components["schemas"]["CorrelationId"]; + payer: components["schemas"]["Party"]; + geoCode?: components["schemas"]["GeoCode"]; + expiration?: components["schemas"]["DateTime"]; + /** @description List of quotes elements. */ + individualQuotes: components["schemas"]["IndividualQuote"][]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkTransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP. + * - PENDING - Payee FSP has validated the bulk transfer. + * - ACCEPTED - Payee FSP has accepted to process the bulk transfer. + * - PROCESSING - Payee FSP has started to transfer fund to the Payees. + * - COMPLETED - Payee FSP has completed transfer of funds to the Payees. + * - REJECTED - Payee FSP has rejected to process the bulk transfer. + * @example RECEIVED + * @enum {string} + */ + BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED"; + /** + * BulkTransfersIDPutResponse + * @description The object sent in the PUT /bulkTransfers/{ID} callback. + */ + BulkTransfersIDPutResponse: { + completedTimestamp?: components["schemas"]["DateTime"]; + /** @description List of IndividualTransferResult elements. */ + individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; + bulkTransferState: components["schemas"]["BulkTransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkTransfersPostRequest + * @description The object sent in the POST /bulkTransfers request. + */ + BulkTransfersPostRequest: { + bulkTransferId: components["schemas"]["CorrelationId"]; + bulkQuoteId: components["schemas"]["CorrelationId"]; + payerFsp: components["schemas"]["FspId"]; + payeeFsp: components["schemas"]["FspId"]; + /** @description List of IndividualTransfer elements. */ + individualTransfers: components["schemas"]["IndividualTransfer"][]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Code + * @description Any code/token returned by the Payee FSP (TokenCode Type). + * @example Test-Code + */ + Code: string; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** + * Date + * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”. + */ + Date: string; + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorInformationObject + * @description Data model for the complex type object that contains ErrorInformation. + */ + ErrorInformationObject: { + errorInformation: components["schemas"]["ErrorInformation"]; + }; + /** + * ErrorInformationResponse + * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. + */ + ErrorInformationResponse: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IndividualQuote + * @description Data model for the complex type IndividualQuote. + */ + IndividualQuote: { + quoteId: components["schemas"]["CorrelationId"]; + transactionId: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + amountType: components["schemas"]["AmountType"]; + amount: components["schemas"]["Money"]; + fees?: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + note?: components["schemas"]["Note"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualQuoteResult + * @description Data model for the complex type IndividualQuoteResult. + */ + IndividualQuoteResult: { + quoteId: components["schemas"]["CorrelationId"]; + payee?: components["schemas"]["Party"]; + transferAmount?: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + ilpPacket?: components["schemas"]["IlpPacket"]; + condition?: components["schemas"]["IlpCondition"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualTransfer + * @description Data model for the complex type IndividualTransfer. + */ + IndividualTransfer: { + transferId: components["schemas"]["CorrelationId"]; + transferAmount: components["schemas"]["Money"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualTransferResult + * @description Data model for the complex type IndividualTransferResult. + */ + IndividualTransferResult: { + transferId: components["schemas"]["CorrelationId"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Integer + * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. + */ + Integer: string; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * Name + * @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. + * + * 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 ( ). + * + * **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. + */ + Name: string; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * OtpValue + * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed. + */ + OtpValue: string; + /** + * ParticipantsIDPutResponse + * @description The object sent in the PUT /participants/{ID} callback. + */ + ParticipantsIDPutResponse: { + /** @description List of PartyResult elements that were either created or failed to be created. */ + partyList: components["schemas"]["PartyResult"][]; + currency?: components["schemas"]["Currency"]; + }; + /** + * ParticipantsPostRequest + * @description The object sent in the POST /participants request. + */ + ParticipantsPostRequest: { + requestId: components["schemas"]["CorrelationId"]; + /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */ + partyList: components["schemas"]["PartyIdInfo"][]; + currency?: components["schemas"]["Currency"]; + }; + /** + * ParticipantsTypeIDPutResponse + * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. + */ + ParticipantsTypeIDPutResponse: { + fspId?: components["schemas"]["FspId"]; + }; + /** + * ParticipantsTypeIDSubIDPostRequest + * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes. + */ + ParticipantsTypeIDSubIDPostRequest: { + fspId: components["schemas"]["FspId"]; + currency?: components["schemas"]["Currency"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartiesTypeIDPutResponse + * @description The object sent in the PUT /parties/{Type}/{ID} callback. + */ + PartiesTypeIDPutResponse: { + party: components["schemas"]["Party"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + }; + /** + * PartyResult + * @description Data model for the complex type PartyResult. + */ + PartyResult: { + partyId: components["schemas"]["PartyIdInfo"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * PersonalIdentifierType + * @description Below are the allowed values for the enumeration. + * - PASSPORT - A passport number is used as reference to a Party. + * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party. + * - DRIVING_LICENSE - A driving license is used as reference to a Party. + * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party. + * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party. + * - EMPLOYER_ID - A tax identification number is used as reference to a Party. + * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party. + * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party. + * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party. + * - HEALTH_CARD - A health card number is used as reference to a Party. + * - VOTERS_ID - A voter’s identification number is used as reference to a Party. + * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party. + * - OTHER_ID - Any other type of identification type number is used as reference to a Party. + * @enum {string} + */ + PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID"; + /** + * QRCODE + * @description QR code used as a One Time Password. + */ + QRCODE: string; + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + QuotesIDPutResponse: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + expiration: components["schemas"]["DateTime"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * QuotesPostRequest + * @description The object sent in the POST /quotes request. + */ + QuotesPostRequest: { + quoteId: components["schemas"]["CorrelationId"]; + transactionId: components["schemas"]["CorrelationId"]; + transactionRequestId?: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + amountType: components["schemas"]["AmountType"]; + amount: components["schemas"]["Money"]; + fees?: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + geoCode?: components["schemas"]["GeoCode"]; + note?: components["schemas"]["Note"]; + expiration?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Refund + * @description Data model for the complex type Refund. + */ + Refund: { + originalTransactionId: components["schemas"]["CorrelationId"]; + refundReason?: components["schemas"]["RefundReason"]; + }; + /** + * RefundReason + * @description Reason for the refund. + * @example Free text indicating reason for the refund. + */ + RefundReason: string; + /** + * TokenCode + * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z. + */ + TokenCode: string; + /** + * Transaction + * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request. + */ + Transaction: { + transactionId: components["schemas"]["CorrelationId"]; + quoteId: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + amount: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + note?: components["schemas"]["Note"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionInitiator + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * @example PAYEE + * @enum {string} + */ + TransactionInitiator: "PAYER" | "PAYEE"; + /** + * TransactionInitiatorType + * @description Below are the allowed values for the enumeration. + * - CONSUMER - Consumer is the initiator of the transaction. + * - AGENT - Agent is the initiator of the transaction. + * - BUSINESS - Business is the initiator of the transaction. + * - DEVICE - Device is the initiator of the transaction. + * @example CONSUMER + * @enum {string} + */ + TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** + * TransactionRequestState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. + * - PENDING - Payer FSP has sent the transaction request to the Payer. + * - ACCEPTED - Payer has approved the transaction. + * - REJECTED - Payer has rejected the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * TransactionRequestsIDPutResponse + * @description The object sent in the PUT /transactionRequests/{ID} callback. + */ + TransactionRequestsIDPutResponse: { + transactionId?: components["schemas"]["CorrelationId"]; + transactionRequestState: components["schemas"]["TransactionRequestState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionRequestsPostRequest + * @description The object sent in the POST /transactionRequests request. + */ + TransactionRequestsPostRequest: { + transactionRequestId: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["PartyIdInfo"]; + amount: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + note?: components["schemas"]["Note"]; + geoCode?: components["schemas"]["GeoCode"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + expiration?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionScenario + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. + * - 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. + * - REFUND - Used for performing a refund of transaction. + * @example DEPOSIT + * @enum {string} + */ + TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; + /** + * TransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. + * - PENDING - Payee FSP has validated the transaction. + * - COMPLETED - Payee FSP has successfully performed the transaction. + * - REJECTED - Payee FSP has failed to perform the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + /** + * TransactionType + * @description Data model for the complex type TransactionType. + */ + TransactionType: { + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + refundInfo?: components["schemas"]["Refund"]; + balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; + }; + /** + * TransactionsIDPutResponse + * @description The object sent in the PUT /transactions/{ID} callback. + */ + TransactionsIDPutResponse: { + completedTimestamp?: components["schemas"]["DateTime"]; + transactionState: components["schemas"]["TransactionState"]; + code?: components["schemas"]["Code"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @example RESERVED + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** + * TransfersIDPatchResponse + * @description PATCH /transfers/{ID} object + */ + TransfersIDPatchResponse: { + completedTimestamp: components["schemas"]["DateTime"]; + transferState: components["schemas"]["TransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransfersIDPutResponse + * @description The object sent in the PUT /transfers/{ID} callback. + */ + TransfersIDPutResponse: { + fulfilment?: components["schemas"]["IlpFulfilment"]; + completedTimestamp?: components["schemas"]["DateTime"]; + transferState: components["schemas"]["TransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransfersPostRequest + * @description The object sent in the POST /transfers request. + */ + TransfersPostRequest: { + transferId: components["schemas"]["CorrelationId"]; + payeeFsp: components["schemas"]["FspId"]; + payerFsp: components["schemas"]["FspId"]; + amount: components["schemas"]["Money"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * U2FPIN + * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. + * + */ + U2FPIN: string; + /** + * U2FPinValue + * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. + * + */ + U2FPinValue: { + /** @description U2F challenge-response. */ + pinValue: components["schemas"]["U2FPIN"]; + /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */ + counter: components["schemas"]["Integer"]; + }; + /** + * UndefinedEnum + * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_). + */ + UndefinedEnum: string; }; responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information - * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. - */ - TransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersIDPutResponse"]; - }; + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Method Not Allowed */ + 405: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Acceptable */ + 406: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Implemented */ + 501: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Service Unavailable */ + 503: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information - * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. - */ - TransfersByIDPatch: { parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer notification upon completion. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersIDPatchResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information error - * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. - */ - TransfersByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transaction information - * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). - */ - TransactionsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction information - * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - TransactionsByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transaction information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction information error - * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - TransactionsErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate bulk quote - * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. - */ - BulkQuotes: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the bulk quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkQuotesPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve bulk quote information - * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. - */ - BulkQuotesByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk quote information - * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - BulkQuotesByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Bulk quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkQuotesIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk quote information error - * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - BulkQuotesErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform bulk transfer - * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. - */ - BulkTransfers: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the bulk transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkTransfersPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve bulk transfer information - * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. - */ - BulkTransferByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk transfer information - * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - BulkTransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Bulk transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkTransfersIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk transfer information error - * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - BulkTransfersErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: string; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: string; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination": string; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption": string; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method": string; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature": string; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": string; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI": string; + /** @description The identifier value. */ + ID: string; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: string; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For": string; + }; + requestBodies: never; + headers: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + }; + pathItems: never; +} +export type $defs = Record; +export interface operations { + ParticipantsByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByIDAndType: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndIDPost: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + Participants1: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + putParticipantsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdByTypeAndIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequests: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Transaction request to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionRequestsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequestsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequestsByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transaction request information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionRequestsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequestsErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + Quotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["QuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["QuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + AuthorizationsByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + AuthorizationsByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Authorization result returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["AuthorizationsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + AuthorizationsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + transfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDPatch: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer notification upon completion. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersIDPatchResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionsByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transaction information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionsErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the bulk quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkQuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Bulk quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkQuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotesErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the bulk transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkTransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransferByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Bulk transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkTransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransfersErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; } diff --git a/src/fspiop/v2_0/openapi.ts b/src/fspiop/v2_0/openapi.ts index ba7a34a1..965f4820 100644 --- a/src/fspiop/v2_0/openapi.ts +++ b/src/fspiop/v2_0/openapi.ts @@ -3,3970 +3,5348 @@ * Do not make direct changes to the file. */ - export interface paths { - "/participants/{Type}/{ID}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - post: operations["ParticipantsByIDAndType"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants/{Type}/{ID}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsErrorByTypeAndID"]; - }; - "/participants/{Type}/{ID}/{SubId}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsSubIdByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsSubIdByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - post: operations["ParticipantsSubIdByTypeAndIDPost"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsSubIdByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/participants/{Type}/{ID}/{SubId}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsSubIdErrorByTypeAndID"]; - }; - "/participants": { - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - post: operations["Participants1"]; - }; - "/participants/{ID}": { - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - put: operations["putParticipantsByID"]; - }; - "/participants/{ID}/error": { - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - put: operations["ParticipantsByIDAndError"]; - }; - "/parties/{Type}/{ID}": { - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - get: operations["PartiesByTypeAndID"]; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - put: operations["PartiesByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/parties/{Type}/{ID}/error": { - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. - */ - put: operations["PartiesErrorByTypeAndID"]; - }; - "/parties/{Type}/{ID}/{SubId}": { - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - get: operations["PartiesSubIdByTypeAndID"]; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - put: operations["PartiesSubIdByTypeAndIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/parties/{Type}/{ID}/{SubId}/error": { - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["PartiesSubIdErrorByTypeAndID"]; - }; - "/transactionRequests": { - /** - * Perform transaction request - * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. - */ - post: operations["TransactionRequests"]; - }; - "/transactionRequests/{ID}": { - /** - * Retrieve transaction request information - * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. - */ - get: operations["TransactionRequestsByID"]; - /** - * Return transaction request information - * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - put: operations["TransactionRequestsByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transactionRequests/{ID}/error": { - /** - * Return transaction request information error - * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - put: operations["TransactionRequestsErrorByID"]; - }; - "/quotes": { - /** - * Calculate quote - * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. - */ - post: operations["Quotes"]; - }; - "/quotes/{ID}": { - /** - * Retrieve quote information - * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. - */ - get: operations["QuotesByID"]; - /** - * Return quote information - * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - put: operations["QuotesByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/quotes/{ID}/error": { - /** - * Return quote information error - * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - put: operations["QuotesByIDAndError"]; - }; - "/authorizations/{ID}": { - /** - * Perform authorization - * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* - * - * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. - * - * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. - * - * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. - * - * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. - * - * The following is an example URI containing all the required key-value pairs in the query string*:* - * - * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` - */ - get: operations["AuthorizationsByIDGet"]; - /** - * Return authorization result - * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. - */ - put: operations["AuthorizationsByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/authorizations/{ID}/error": { - /** - * Return authorization error - * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. - */ - put: operations["AuthorizationsByIDAndError"]; - }; - "/transfers": { - /** - * Perform transfer - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. - */ - post: operations["transfers"]; - }; - "/transfers/{ID}": { - /** - * Retrieve transfer information - * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. - */ - get: operations["TransfersByIDGet"]; - /** - * Return transfer information - * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. - */ - put: operations["TransfersByIDPut"]; - /** - * Return transfer information - * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. - */ - patch: operations["TransfersByIDPatch"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transfers/{ID}/error": { - /** - * Return transfer information error - * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. - */ - put: operations["TransfersByIDAndError"]; - }; - "/transactions/{ID}": { - /** - * Retrieve transaction information - * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). - */ - get: operations["TransactionsByID"]; - /** - * Return transaction information - * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - put: operations["TransactionsByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/transactions/{ID}/error": { - /** - * Return transaction information error - * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - put: operations["TransactionsErrorByID"]; - }; - "/bulkQuotes": { - /** - * Calculate bulk quote - * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. - */ - post: operations["BulkQuotes"]; - }; - "/bulkQuotes/{ID}": { - /** - * Retrieve bulk quote information - * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. - */ - get: operations["BulkQuotesByID"]; - /** - * Return bulk quote information - * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - put: operations["BulkQuotesByID1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/bulkQuotes/{ID}/error": { - /** - * Return bulk quote information error - * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - put: operations["BulkQuotesErrorByID"]; - }; - "/bulkTransfers": { - /** - * Perform bulk transfer - * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. - */ - post: operations["BulkTransfers"]; - }; - "/bulkTransfers/{ID}": { - /** - * Retrieve bulk transfer information - * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. - */ - get: operations["BulkTransferByID"]; - /** - * Return bulk transfer information - * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - put: operations["BulkTransfersByIDPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/bulkTransfers/{ID}/error": { - /** - * Return bulk transfer information error - * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - put: operations["BulkTransfersErrorByID"]; - }; - "/fxQuotes": { - /** - * Calculate FX quote - * @description The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion. - */ - post: operations["FxQuotesPost"]; - }; - "/fxQuotes/{ID}": { - /** - * Retrieve FX quote information - * @description The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote. - */ - get: operations["FxQuotesByIDGet"]; - /** - * Return FX quote information - * @description The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. - */ - put: operations["FxQuotesByIdPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/fxQuotes/{ID}/error": { - /** - * Return FX quote information error - * @description If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. - */ - put: operations["FxQuotesByIDAndErrorPut"]; - }; - "/fxTransfers": { - /** - * Perform FX transfer - * @description The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion. - */ - post: operations["FxTransfersPost"]; - }; - "/fxTransfers/{ID}": { - /** - * Retrieve FX transfer information - * @description The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer. - */ - get: operations["FxTransfersByIDGet"]; - /** - * Return FX transfer information - * @description The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request. - */ - put: operations["FxTransfersByIDPut"]; - /** - * Return FX transfer information - * @description The HTTP request PATCH /fxTransfers/ is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback. - */ - patch: operations["FxTransfersByIDPatch"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/fxTransfers/{ID}/error": { - /** - * Return FX transfer information error - * @description If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. - */ - put: operations["FxTransfersByIDAndErrorPut"]; - }; - "/services/FXP": { - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services. - */ - get: operations["ServicesFXPGet"]; - /** @description The callback `PUT /services/FXP` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. */ - put: operations["ServicesFXPPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/services/FXP/{SourceCurrency}/{TargetCurrency}": { - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @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. - */ - get: operations["ServicesFXPSourceCurrencyTargetCurrencyGet"]; - /** @description The callback `PUT /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency. */ - put: operations["ServicesFXPSourceCurrencyTargetCurrencyPut"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - SourceCurrency: components["parameters"]["SourceCurrency"]; - TargetCurrency: components["parameters"]["TargetCurrency"]; - }; - }; - }; + "/participants/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 + */ + post: operations["ParticipantsByIDAndType"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsSubIdByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsSubIdByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 + */ + post: operations["ParticipantsSubIdByTypeAndIDPost"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsSubIdByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create bulk participant information + * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. + */ + post: operations["Participants1"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information + * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. + */ + put: operations["putParticipantsByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information error + * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. + */ + put: operations["ParticipantsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesByTypeAndID2"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. + */ + put: operations["PartiesErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesSubIdByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesSubIdByTypeAndIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["PartiesSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transaction request + * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. + */ + post: operations["TransactionRequests"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transaction request information + * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. + */ + get: operations["TransactionRequestsByID"]; + /** + * Return transaction request information + * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. + */ + put: operations["TransactionRequestsByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionRequests/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transaction request information error + * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. + */ + put: operations["TransactionRequestsErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate quote + * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. + */ + post: operations["Quotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve quote information + * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. + */ + get: operations["QuotesByID"]; + /** + * Return quote information + * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return quote information error + * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/authorizations/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Perform authorization + * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* + * + * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. + * + * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. + * + * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. + * + * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. + * + * The following is an example URI containing all the required key-value pairs in the query string*:* + * + * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` + */ + get: operations["AuthorizationsByIDGet"]; + /** + * Return authorization result + * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. + */ + put: operations["AuthorizationsByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/authorizations/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return authorization error + * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. + */ + put: operations["AuthorizationsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transfer + * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. + */ + post: operations["transfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transfer information + * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. + */ + get: operations["TransfersByIDGet"]; + /** + * Return transfer information + * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. + */ + put: operations["TransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Return transfer information + * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. + */ + patch: operations["TransfersByIDPatch"]; + trace?: never; + }; + "/transfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transfer information error + * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. + */ + put: operations["TransfersByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transaction information + * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). + */ + get: operations["TransactionsByID"]; + /** + * Return transaction information + * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. + */ + put: operations["TransactionsByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactions/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transaction information error + * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. + */ + put: operations["TransactionsErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate bulk quote + * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. + */ + post: operations["BulkQuotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve bulk quote information + * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. + */ + get: operations["BulkQuotesByID"]; + /** + * Return bulk quote information + * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. + */ + put: operations["BulkQuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk quote information error + * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. + */ + put: operations["BulkQuotesErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform bulk transfer + * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. + */ + post: operations["BulkTransfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve bulk transfer information + * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. + */ + get: operations["BulkTransferByID"]; + /** + * Return bulk transfer information + * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. + */ + put: operations["BulkTransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return bulk transfer information error + * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. + */ + put: operations["BulkTransfersErrorByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate FX quote + * @description The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion. + */ + post: operations["FxQuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve FX quote information + * @description The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote. + */ + get: operations["FxQuotesByIDGet"]; + /** + * Return FX quote information + * @description The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. + */ + put: operations["FxQuotesByIdPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return FX quote information error + * @description If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. + */ + put: operations["FxQuotesByIDAndErrorPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform FX transfer + * @description The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion. + */ + post: operations["FxTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve FX transfer information + * @description The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer. + */ + get: operations["FxTransfersByIDGet"]; + /** + * Return FX transfer information + * @description The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request. + */ + put: operations["FxTransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Return FX transfer information + * @description The HTTP request PATCH /fxTransfers/ is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback. + */ + patch: operations["FxTransfersByIDPatch"]; + trace?: never; + }; + "/fxTransfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return FX transfer information error + * @description If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. + */ + put: operations["FxTransfersByIDAndErrorPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/services/FXP": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** + * Obtain a list of the DFSPs in the scheme who provide FXP service + * @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services. + */ + get: operations["ServicesFXPGet"]; + /** @description The callback `PUT /services/FXP` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. */ + put: operations["ServicesFXPPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/services/FXP/{SourceCurrency}/{TargetCurrency}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description ISO 4217 currency code for the source currency. */ + SourceCurrency: components["parameters"]["SourceCurrency"]; + /** @description ISO 4217 currency code for the target currency. */ + TargetCurrency: components["parameters"]["TargetCurrency"]; + }; + cookie?: never; + }; + /** + * Obtain a list of the DFSPs in the scheme who provide FXP service + * @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. + */ + get: operations["ServicesFXPSourceCurrencyTargetCurrencyGet"]; + /** @description The callback `PUT /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency. */ + put: operations["ServicesFXPSourceCurrencyTargetCurrencyPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * AuthenticationInfo - * @description Data model for the complex type AuthenticationInfo. - */ - AuthenticationInfo: { - authentication: components["schemas"]["AuthenticationType"]; - authenticationValue: components["schemas"]["AuthenticationValue"]; - }; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * - U2F - U2F is a new addition isolated to Thirdparty stream. - * @example OTP - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE" | "U2F"; - /** - * AuthenticationValue - * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. - */ - AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"]; - /** - * AuthorizationResponse - * @description Below are the allowed values for the enumeration. - * - ENTERED - Consumer entered the authentication value. - * - REJECTED - Consumer rejected the transaction. - * - RESEND - Consumer requested to resend the authentication value. - * @example ENTERED - * @enum {string} - */ - AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND"; - /** - * AuthorizationsIDPutResponse - * @description The object sent in the PUT /authorizations/{ID} callback. - */ - AuthorizationsIDPutResponse: { - authenticationInfo?: components["schemas"]["AuthenticationInfo"]; - responseType: components["schemas"]["AuthorizationResponse"]; - }; - /** - * BalanceOfPayments - * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. - * @example 123 - */ - BalanceOfPayments: string; - /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ - BinaryString: string; - /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */ - BinaryString32: string; - /** - * BulkQuotesIDPutResponse - * @description The object sent in the PUT /bulkQuotes/{ID} callback. - */ - BulkQuotesIDPutResponse: { - /** @description Fees for each individual transaction, if any of them are charged per transaction. */ - individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkQuotesPostRequest - * @description The object sent in the POST /bulkQuotes request. - */ - BulkQuotesPostRequest: { - bulkQuoteId: components["schemas"]["CorrelationId"]; - payer: components["schemas"]["Party"]; - geoCode?: components["schemas"]["GeoCode"]; - expiration?: components["schemas"]["DateTime"]; - /** @description List of quotes elements. */ - individualQuotes: components["schemas"]["IndividualQuote"][]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkTransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP. - * - PENDING - Payee FSP has validated the bulk transfer. - * - ACCEPTED - Payee FSP has accepted to process the bulk transfer. - * - PROCESSING - Payee FSP has started to transfer fund to the Payees. - * - COMPLETED - Payee FSP has completed transfer of funds to the Payees. - * - REJECTED - Payee FSP has rejected to process the bulk transfer. - * @example RECEIVED - * @enum {string} - */ - BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED"; - /** - * BulkTransfersIDPutResponse - * @description The object sent in the PUT /bulkTransfers/{ID} callback. - */ - BulkTransfersIDPutResponse: { - completedTimestamp?: components["schemas"]["DateTime"]; - /** @description List of IndividualTransferResult elements. */ - individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; - bulkTransferState: components["schemas"]["BulkTransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * BulkTransfersPostRequest - * @description The object sent in the POST /bulkTransfers request. - */ - BulkTransfersPostRequest: { - bulkTransferId: components["schemas"]["CorrelationId"]; - bulkQuoteId: components["schemas"]["CorrelationId"]; - payerFsp: components["schemas"]["FspId"]; - payeeFsp: components["schemas"]["FspId"]; - /** @description List of IndividualTransfer elements. */ - individualTransfers: components["schemas"]["IndividualTransfer"][]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Code - * @description Any code/token returned by the Payee FSP (TokenCode Type). - * @example Test-Code - */ - Code: string; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** - * CurrencyConverter - * @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee. - * @enum {string} - */ - CurrencyConverter: "PAYER" | "PAYEE"; - /** - * Date - * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”. - */ - Date: string; - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ErrorInformationObject - * @description Data model for the complex type object that contains ErrorInformation. - */ - ErrorInformationObject: { - errorInformation: components["schemas"]["ErrorInformation"]; - }; - /** - * ErrorInformationResponse - * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. - */ - ErrorInformationResponse: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** - * FxCharge - * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object. - */ - FxCharge: { - /** @description A description of the charge which is being levied. */ - chargeType: string; - sourceAmount?: components["schemas"]["Money"]; - targetAmount?: components["schemas"]["Money"]; - }; - /** - * FxConversion - * @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. - */ - FxConversion: { - conversionId: components["schemas"]["CorrelationId"]; - determiningTransferId?: components["schemas"]["CorrelationId"]; - initiatingFsp: components["schemas"]["FspId"]; - counterPartyFsp: components["schemas"]["FspId"]; - amountType: components["schemas"]["AmountType"]; - sourceAmount: components["schemas"]["FxMoney"]; - targetAmount: components["schemas"]["FxMoney"]; - expiration: components["schemas"]["DateTime"]; - /** @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. */ - charges?: components["schemas"]["FxCharge"][]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxMoney - * @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations. - */ - FxMoney: { - currency: components["schemas"]["Currency"]; - amount?: components["schemas"]["Amount"]; - }; - /** - * FxQuotesIDPutResponse - * @description The object sent in the PUT /fxQuotes/{ID} callback. - */ - FxQuotesIDPutResponse: { - condition?: components["schemas"]["IlpCondition"]; - conversionTerms: components["schemas"]["FxConversion"]; - }; - /** - * FxQuotesPostRequest - * @description The object sent in the POST /fxQuotes request. - */ - FxQuotesPostRequest: { - conversionRequestId: components["schemas"]["CorrelationId"]; - conversionTerms: components["schemas"]["FxConversion"]; - }; - /** - * FxRate - * @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. - */ - FxRate: { - sourceAmount: components["schemas"]["Money"]; - targetAmount: components["schemas"]["Money"]; - }; - /** - * FxTransfersIDPatchResponse - * @description PATCH /fxTransfers/{ID} object - */ - FxTransfersIDPatchResponse: { - completedTimestamp?: components["schemas"]["DateTime"]; - conversionState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxTransfersIDPutResponse - * @description The object sent in the PUT /fxTransfers/{ID} callback. - */ - FxTransfersIDPutResponse: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - completedTimestamp?: components["schemas"]["DateTime"]; - conversionState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxTransfersPostRequest - * @description The object sent in the POST /fxTransfers request. - */ - FxTransfersPostRequest: { - commitRequestId: components["schemas"]["CorrelationId"]; - determiningTransferId?: components["schemas"]["CorrelationId"]; - initiatingFsp: components["schemas"]["FspId"]; - counterPartyFsp: components["schemas"]["FspId"]; - sourceAmount: components["schemas"]["Money"]; - targetAmount: components["schemas"]["Money"]; - condition: components["schemas"]["IlpCondition"]; - expiration?: components["schemas"]["DateTime"]; - }; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IndividualQuote - * @description Data model for the complex type IndividualQuote. - */ - IndividualQuote: { - quoteId: components["schemas"]["CorrelationId"]; - transactionId: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - amountType: components["schemas"]["AmountType"]; - amount: components["schemas"]["Money"]; - fees?: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - note?: components["schemas"]["Note"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualQuoteResult - * @description Data model for the complex type IndividualQuoteResult. - */ - IndividualQuoteResult: { - quoteId: components["schemas"]["CorrelationId"]; - payee?: components["schemas"]["Party"]; - transferAmount?: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - ilpPacket?: components["schemas"]["IlpPacket"]; - condition?: components["schemas"]["IlpCondition"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualTransfer - * @description Data model for the complex type IndividualTransfer. - */ - IndividualTransfer: { - transferId: components["schemas"]["CorrelationId"]; - transferAmount: components["schemas"]["Money"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * IndividualTransferResult - * @description Data model for the complex type IndividualTransferResult. - */ - IndividualTransferResult: { - transferId: components["schemas"]["CorrelationId"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Integer - * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. - */ - Integer: string; - /** - * KYCInformation - * @description KYC information for the party in a form mandated by an individual scheme. - * @example { - * "metadata": { - * "format": "JSON", - * "version": "1.0", - * "description": "Data containing KYC Information" - * }, - * "data": { - * "name": "John Doe", - * "dob": "1980-05-15", - * "gender": "Male", - * "address": "123 Main Street, Anytown, USA", - * "email": "johndoe@example.com", - * "phone": "+1 555-123-4567", - * "nationality": "US", - * "passport_number": "AB1234567", - * "issue_date": "2010-02-20", - * "expiry_date": "2025-02-20", - * "bank_account_number": "1234567890", - * "bank_name": "Example Bank", - * "employer": "ABC Company", - * "occupation": "Software Engineer", - * "income": "$80,000 per year", - * "marital_status": "Single", - * "dependents": 0, - * "risk_level": "Low" - * } - * } - */ - KYCInformation: string; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * Name - * @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. - * - * 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 ( ). - * - * **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. - */ - Name: string; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * OtpValue - * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed. - */ - OtpValue: string; - /** - * ParticipantsIDPutResponse - * @description The object sent in the PUT /participants/{ID} callback. - */ - ParticipantsIDPutResponse: { - /** @description List of PartyResult elements that were either created or failed to be created. */ - partyList: components["schemas"]["PartyResult"][]; - currency?: components["schemas"]["Currency"]; - }; - /** - * ParticipantsPostRequest - * @description The object sent in the POST /participants request. - */ - ParticipantsPostRequest: { - requestId: components["schemas"]["CorrelationId"]; - /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */ - partyList: components["schemas"]["PartyIdInfo"][]; - currency?: components["schemas"]["Currency"]; - }; - /** - * ParticipantsTypeIDPutResponse - * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. - */ - ParticipantsTypeIDPutResponse: { - fspId?: components["schemas"]["FspId"]; - }; - /** - * ParticipantsTypeIDSubIDPostRequest - * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes. - */ - ParticipantsTypeIDSubIDPostRequest: { - fspId: components["schemas"]["FspId"]; - currency?: components["schemas"]["Currency"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartiesTypeIDPutResponse - * @description The object sent in the PUT /parties/{Type}/{ID} callback. - */ - PartiesTypeIDPutResponse: { - party: components["schemas"]["Party"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - /** @description Currencies in which the party can receive funds. */ - supportedCurrencies?: components["schemas"]["Currency"][]; - }; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - kycInformation?: components["schemas"]["KYCInformation"]; - }; - /** - * PartyResult - * @description Data model for the complex type PartyResult. - */ - PartyResult: { - partyId: components["schemas"]["PartyIdInfo"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * PersonalIdentifierType - * @description Below are the allowed values for the enumeration. - * - PASSPORT - A passport number is used as reference to a Party. - * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party. - * - DRIVING_LICENSE - A driving license is used as reference to a Party. - * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party. - * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party. - * - EMPLOYER_ID - A tax identification number is used as reference to a Party. - * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party. - * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party. - * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party. - * - HEALTH_CARD - A health card number is used as reference to a Party. - * - VOTERS_ID - A voter’s identification number is used as reference to a Party. - * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party. - * - OTHER_ID - Any other type of identification type number is used as reference to a Party. - * @enum {string} - */ - PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID"; - /** - * QRCODE - * @description QR code used as a One Time Password. - */ - QRCODE: string; - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - QuotesIDPutResponse: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - expiration: components["schemas"]["DateTime"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * QuotesPostRequest - * @description The object sent in the POST /quotes request. - */ - QuotesPostRequest: { - quoteId: components["schemas"]["CorrelationId"]; - transactionId: components["schemas"]["CorrelationId"]; - transactionRequestId?: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - amountType: components["schemas"]["AmountType"]; - amount: components["schemas"]["Money"]; - fees?: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - converter?: components["schemas"]["CurrencyConverter"]; - currencyConversion?: components["schemas"]["FxRate"]; - geoCode?: components["schemas"]["GeoCode"]; - note?: components["schemas"]["Note"]; - expiration?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * Refund - * @description Data model for the complex type Refund. - */ - Refund: { - originalTransactionId: components["schemas"]["CorrelationId"]; - refundReason?: components["schemas"]["RefundReason"]; - }; - /** - * RefundReason - * @description Reason for the refund. - * @example Free text indicating reason for the refund. - */ - RefundReason: string; - /** - * ServicesFXPPutResponse - * @description The object sent in the PUT /services/FXP callback. - */ - ServicesFXPPutResponse: { - /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */ - providers: components["schemas"]["FspId"][]; - }; - /** - * ServicesFXPSourceCurrencyTargetCurrencyPutResponse - * @description The object sent in the PUT /services/FXP/{SourceCurrency}/{TargetCurrency} callback. - */ - ServicesFXPSourceCurrencyTargetCurrencyPutResponse: { - /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */ - providers: components["schemas"]["FspId"][]; - }; - /** - * TokenCode - * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z. - */ - TokenCode: string; - /** - * Transaction - * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request. - */ - Transaction: { - transactionId: components["schemas"]["CorrelationId"]; - quoteId: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - amount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - converter?: components["schemas"]["CurrencyConverter"]; - currencyConversion?: components["schemas"]["FxRate"]; - transactionType: components["schemas"]["TransactionType"]; - note?: components["schemas"]["Note"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionInitiator - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * @example PAYEE - * @enum {string} - */ - TransactionInitiator: "PAYER" | "PAYEE"; - /** - * TransactionInitiatorType - * @description Below are the allowed values for the enumeration. - * - CONSUMER - Consumer is the initiator of the transaction. - * - AGENT - Agent is the initiator of the transaction. - * - BUSINESS - Business is the initiator of the transaction. - * - DEVICE - Device is the initiator of the transaction. - * @example CONSUMER - * @enum {string} - */ - TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** - * TransactionRequestState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. - * - PENDING - Payer FSP has sent the transaction request to the Payer. - * - ACCEPTED - Payer has approved the transaction. - * - REJECTED - Payer has rejected the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * TransactionRequestsIDPutResponse - * @description The object sent in the PUT /transactionRequests/{ID} callback. - */ - TransactionRequestsIDPutResponse: { - transactionId?: components["schemas"]["CorrelationId"]; - transactionRequestState: components["schemas"]["TransactionRequestState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionRequestsPostRequest - * @description The object sent in the POST /transactionRequests request. - */ - TransactionRequestsPostRequest: { - transactionRequestId: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["PartyIdInfo"]; - amount: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - note?: components["schemas"]["Note"]; - geoCode?: components["schemas"]["GeoCode"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - expiration?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionScenario - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. - * - 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. - * - REFUND - Used for performing a refund of transaction. - * @example DEPOSIT - * @enum {string} - */ - TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; - /** - * TransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. - * - PENDING - Payee FSP has validated the transaction. - * - COMPLETED - Payee FSP has successfully performed the transaction. - * - REJECTED - Payee FSP has failed to perform the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - /** - * TransactionType - * @description Data model for the complex type TransactionType. - */ - TransactionType: { - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - refundInfo?: components["schemas"]["Refund"]; - balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; - }; - /** - * TransactionsIDPutResponse - * @description The object sent in the PUT /transactions/{ID} callback. - */ - TransactionsIDPutResponse: { - completedTimestamp?: components["schemas"]["DateTime"]; - transactionState: components["schemas"]["TransactionState"]; - code?: components["schemas"]["Code"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @example RESERVED - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** - * TransfersIDPatchResponse - * @description PATCH /transfers/{ID} object - */ - TransfersIDPatchResponse: { - completedTimestamp: components["schemas"]["DateTime"]; - transferState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransfersIDPutResponse - * @description The object sent in the PUT /transfers/{ID} callback. - */ - TransfersIDPutResponse: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - completedTimestamp?: components["schemas"]["DateTime"]; - transferState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransfersPostRequest - * @description The object sent in the POST /transfers request. - */ - TransfersPostRequest: { - transferId: components["schemas"]["CorrelationId"]; - payeeFsp: components["schemas"]["FspId"]; - payerFsp: components["schemas"]["FspId"]; - amount: components["schemas"]["Money"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * U2FPIN - * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. - */ - U2FPIN: string; - /** - * U2FPinValue - * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. - */ - U2FPinValue: { - /** @description U2F challenge-response. */ - pinValue: components["schemas"]["U2FPIN"]; - /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */ - counter: components["schemas"]["Integer"]; - }; - /** - * UndefinedEnum - * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_). - */ - UndefinedEnum: string; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - /** @description Accepted */ - 202: { - content: never; - }; - /** @description Bad Request */ - 400: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Method Not Allowed */ - 405: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Acceptable */ - 406: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Implemented */ - 501: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Service Unavailable */ - 503: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - }; - parameters: { - /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ - Accept: string; - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length"?: number; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - /** @description The `Date` header field indicates the date when the request was sent. */ - Date: string; - /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ - "FSPIOP-Destination"?: string; - /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ - "FSPIOP-Encryption"?: string; - /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-HTTP-Method"?: string; - /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ - "FSPIOP-Signature"?: string; - /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ - "FSPIOP-Source": string; - /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-URI"?: string; - /** @description The identifier value. */ - ID: string; - /** @description ISO 4217 currency code for the source currency. */ - SourceCurrency: string; - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - SubId: string; - /** @description ISO 4217 currency code for the target currency. */ - TargetCurrency: string; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - Type: string; - /** - * @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. - * - * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. - */ - "X-Forwarded-For"?: string; - }; - requestBodies: never; - headers: { - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length": number; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - }; - pathItems: never; -} - -export type $defs = Record; - -export type external = Record; - -export interface operations { - - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; + schemas: { + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * AuthenticationInfo + * @description Data model for the complex type AuthenticationInfo. + */ + AuthenticationInfo: { + authentication: components["schemas"]["AuthenticationType"]; + authenticationValue: components["schemas"]["AuthenticationValue"]; + }; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * - U2F - U2F is a new addition isolated to Thirdparty stream. + * @example OTP + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE" | "U2F"; + /** + * AuthenticationValue + * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. + */ + AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"]; + /** + * AuthorizationResponse + * @description Below are the allowed values for the enumeration. + * - ENTERED - Consumer entered the authentication value. + * - REJECTED - Consumer rejected the transaction. + * - RESEND - Consumer requested to resend the authentication value. + * @example ENTERED + * @enum {string} + */ + AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND"; + /** + * AuthorizationsIDPutResponse + * @description The object sent in the PUT /authorizations/{ID} callback. + */ + AuthorizationsIDPutResponse: { + authenticationInfo?: components["schemas"]["AuthenticationInfo"]; + responseType: components["schemas"]["AuthorizationResponse"]; + }; + /** + * BalanceOfPayments + * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. + * @example 123 + */ + BalanceOfPayments: string; + /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ + BinaryString: string; + /** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */ + BinaryString32: string; + /** + * BulkQuotesIDPutResponse + * @description The object sent in the PUT /bulkQuotes/{ID} callback. + */ + BulkQuotesIDPutResponse: { + /** @description Fees for each individual transaction, if any of them are charged per transaction. */ + individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkQuotesPostRequest + * @description The object sent in the POST /bulkQuotes request. + */ + BulkQuotesPostRequest: { + bulkQuoteId: components["schemas"]["CorrelationId"]; + payer: components["schemas"]["Party"]; + geoCode?: components["schemas"]["GeoCode"]; + expiration?: components["schemas"]["DateTime"]; + /** @description List of quotes elements. */ + individualQuotes: components["schemas"]["IndividualQuote"][]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkTransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP. + * - PENDING - Payee FSP has validated the bulk transfer. + * - ACCEPTED - Payee FSP has accepted to process the bulk transfer. + * - PROCESSING - Payee FSP has started to transfer fund to the Payees. + * - COMPLETED - Payee FSP has completed transfer of funds to the Payees. + * - REJECTED - Payee FSP has rejected to process the bulk transfer. + * @example RECEIVED + * @enum {string} + */ + BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED"; + /** + * BulkTransfersIDPutResponse + * @description The object sent in the PUT /bulkTransfers/{ID} callback. + */ + BulkTransfersIDPutResponse: { + completedTimestamp?: components["schemas"]["DateTime"]; + /** @description List of IndividualTransferResult elements. */ + individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; + bulkTransferState: components["schemas"]["BulkTransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * BulkTransfersPostRequest + * @description The object sent in the POST /bulkTransfers request. + */ + BulkTransfersPostRequest: { + bulkTransferId: components["schemas"]["CorrelationId"]; + bulkQuoteId: components["schemas"]["CorrelationId"]; + payerFsp: components["schemas"]["FspId"]; + payeeFsp: components["schemas"]["FspId"]; + /** @description List of IndividualTransfer elements. */ + individualTransfers: components["schemas"]["IndividualTransfer"][]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Code + * @description Any code/token returned by the Payee FSP (TokenCode Type). + * @example Test-Code + */ + Code: string; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** + * CurrencyConverter + * @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee. + * @enum {string} + */ + CurrencyConverter: "PAYER" | "PAYEE"; + /** + * Date + * @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”. + */ + Date: string; + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorInformationObject + * @description Data model for the complex type object that contains ErrorInformation. + */ + ErrorInformationObject: { + errorInformation: components["schemas"]["ErrorInformation"]; + }; + /** + * ErrorInformationResponse + * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. + */ + ErrorInformationResponse: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** + * FxCharge + * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object. + */ + FxCharge: { + /** @description A description of the charge which is being levied. */ + chargeType: string; + sourceAmount?: components["schemas"]["Money"] & unknown; + targetAmount?: components["schemas"]["Money"] & unknown; + }; + /** + * FxConversion + * @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. + */ + FxConversion: { + conversionId: components["schemas"]["CorrelationId"] & unknown; + determiningTransferId?: components["schemas"]["CorrelationId"] & unknown; + initiatingFsp: components["schemas"]["FspId"] & unknown; + counterPartyFsp: components["schemas"]["FspId"] & unknown; + amountType: components["schemas"]["AmountType"] & unknown; + sourceAmount: components["schemas"]["FxMoney"] & unknown; + targetAmount: components["schemas"]["FxMoney"] & unknown; + expiration: components["schemas"]["DateTime"] & unknown; + /** @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. */ + charges?: components["schemas"]["FxCharge"][]; + extensionList?: components["schemas"]["ExtensionList"] & unknown; + }; + /** + * FxMoney + * @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations. + */ + FxMoney: { + currency: components["schemas"]["Currency"]; + amount?: components["schemas"]["Amount"]; + }; + /** + * FxQuotesIDPutResponse + * @description The object sent in the PUT /fxQuotes/{ID} callback. + */ + FxQuotesIDPutResponse: { + condition?: components["schemas"]["IlpCondition"] & unknown; + conversionTerms: components["schemas"]["FxConversion"] & unknown; + }; + /** + * FxQuotesPostRequest + * @description The object sent in the POST /fxQuotes request. + */ + FxQuotesPostRequest: { + conversionRequestId: components["schemas"]["CorrelationId"] & unknown; + conversionTerms: components["schemas"]["FxConversion"] & unknown; + }; + /** + * FxRate + * @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. + */ + FxRate: { + sourceAmount: components["schemas"]["Money"] & unknown; + targetAmount: components["schemas"]["Money"] & unknown; + }; + /** + * FxTransfersIDPatchResponse + * @description PATCH /fxTransfers/{ID} object + */ + FxTransfersIDPatchResponse: { + completedTimestamp?: components["schemas"]["DateTime"] & unknown; + conversionState: components["schemas"]["TransferState"] & unknown; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * FxTransfersIDPutResponse + * @description The object sent in the PUT /fxTransfers/{ID} callback. + */ + FxTransfersIDPutResponse: { + fulfilment?: components["schemas"]["IlpFulfilment"] & unknown; + completedTimestamp?: components["schemas"]["DateTime"] & unknown; + conversionState: components["schemas"]["TransferState"] & unknown; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * FxTransfersPostRequest + * @description The object sent in the POST /fxTransfers request. + */ + FxTransfersPostRequest: { + commitRequestId: components["schemas"]["CorrelationId"] & unknown; + determiningTransferId?: components["schemas"]["CorrelationId"] & unknown; + initiatingFsp: components["schemas"]["FspId"] & unknown; + counterPartyFsp: components["schemas"]["FspId"] & unknown; + sourceAmount: components["schemas"]["Money"] & unknown; + targetAmount: components["schemas"]["Money"] & unknown; + condition: components["schemas"]["IlpCondition"] & unknown; + expiration?: components["schemas"]["DateTime"]; + }; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IndividualQuote + * @description Data model for the complex type IndividualQuote. + */ + IndividualQuote: { + quoteId: components["schemas"]["CorrelationId"]; + transactionId: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + amountType: components["schemas"]["AmountType"]; + amount: components["schemas"]["Money"]; + fees?: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + note?: components["schemas"]["Note"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualQuoteResult + * @description Data model for the complex type IndividualQuoteResult. + */ + IndividualQuoteResult: { + quoteId: components["schemas"]["CorrelationId"]; + payee?: components["schemas"]["Party"]; + transferAmount?: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + ilpPacket?: components["schemas"]["IlpPacket"]; + condition?: components["schemas"]["IlpCondition"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualTransfer + * @description Data model for the complex type IndividualTransfer. + */ + IndividualTransfer: { + transferId: components["schemas"]["CorrelationId"]; + transferAmount: components["schemas"]["Money"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * IndividualTransferResult + * @description Data model for the complex type IndividualTransferResult. + */ + IndividualTransferResult: { + transferId: components["schemas"]["CorrelationId"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Integer + * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. + */ + Integer: string; + /** + * KYCInformation + * @description KYC information for the party in a form mandated by an individual scheme. + * @example { + * "metadata": { + * "format": "JSON", + * "version": "1.0", + * "description": "Data containing KYC Information" + * }, + * "data": { + * "name": "John Doe", + * "dob": "1980-05-15", + * "gender": "Male", + * "address": "123 Main Street, Anytown, USA", + * "email": "johndoe@example.com", + * "phone": "+1 555-123-4567", + * "nationality": "US", + * "passport_number": "AB1234567", + * "issue_date": "2010-02-20", + * "expiry_date": "2025-02-20", + * "bank_account_number": "1234567890", + * "bank_name": "Example Bank", + * "employer": "ABC Company", + * "occupation": "Software Engineer", + * "income": "$80,000 per year", + * "marital_status": "Single", + * "dependents": 0, + * "risk_level": "Low" + * } + * } + */ + KYCInformation: string; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * Name + * @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. + * + * 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 ( ). + * + * **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. + */ + Name: string; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * OtpValue + * @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed. + */ + OtpValue: string; + /** + * ParticipantsIDPutResponse + * @description The object sent in the PUT /participants/{ID} callback. + */ + ParticipantsIDPutResponse: { + /** @description List of PartyResult elements that were either created or failed to be created. */ + partyList: components["schemas"]["PartyResult"][]; + currency?: components["schemas"]["Currency"]; + }; + /** + * ParticipantsPostRequest + * @description The object sent in the POST /participants request. + */ + ParticipantsPostRequest: { + requestId: components["schemas"]["CorrelationId"]; + /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */ + partyList: components["schemas"]["PartyIdInfo"][]; + currency?: components["schemas"]["Currency"]; + }; + /** + * ParticipantsTypeIDPutResponse + * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. + */ + ParticipantsTypeIDPutResponse: { + fspId?: components["schemas"]["FspId"]; + }; + /** + * ParticipantsTypeIDSubIDPostRequest + * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes. + */ + ParticipantsTypeIDSubIDPostRequest: { + fspId: components["schemas"]["FspId"]; + currency?: components["schemas"]["Currency"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartiesTypeIDPutResponse + * @description The object sent in the PUT /parties/{Type}/{ID} callback. + */ + PartiesTypeIDPutResponse: { + party: components["schemas"]["Party"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + /** @description Currencies in which the party can receive funds. */ + supportedCurrencies?: components["schemas"]["Currency"][]; + }; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + kycInformation?: components["schemas"]["KYCInformation"]; + }; + /** + * PartyResult + * @description Data model for the complex type PartyResult. + */ + PartyResult: { + partyId: components["schemas"]["PartyIdInfo"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * PersonalIdentifierType + * @description Below are the allowed values for the enumeration. + * - PASSPORT - A passport number is used as reference to a Party. + * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party. + * - DRIVING_LICENSE - A driving license is used as reference to a Party. + * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party. + * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party. + * - EMPLOYER_ID - A tax identification number is used as reference to a Party. + * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party. + * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party. + * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party. + * - HEALTH_CARD - A health card number is used as reference to a Party. + * - VOTERS_ID - A voter’s identification number is used as reference to a Party. + * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party. + * - OTHER_ID - Any other type of identification type number is used as reference to a Party. + * @enum {string} + */ + PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID"; + /** + * QRCODE + * @description QR code used as a One Time Password. + */ + QRCODE: string; + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + QuotesIDPutResponse: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + expiration: components["schemas"]["DateTime"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * QuotesPostRequest + * @description The object sent in the POST /quotes request. + */ + QuotesPostRequest: { + quoteId: components["schemas"]["CorrelationId"]; + transactionId: components["schemas"]["CorrelationId"]; + transactionRequestId?: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + amountType: components["schemas"]["AmountType"]; + amount: components["schemas"]["Money"]; + fees?: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + converter?: components["schemas"]["CurrencyConverter"] & unknown; + currencyConversion?: components["schemas"]["FxRate"] & unknown; + geoCode?: components["schemas"]["GeoCode"]; + note?: components["schemas"]["Note"]; + expiration?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * Refund + * @description Data model for the complex type Refund. + */ + Refund: { + originalTransactionId: components["schemas"]["CorrelationId"]; + refundReason?: components["schemas"]["RefundReason"]; + }; + /** + * RefundReason + * @description Reason for the refund. + * @example Free text indicating reason for the refund. + */ + RefundReason: string; + /** + * ServicesFXPPutResponse + * @description The object sent in the PUT /services/FXP callback. + */ + ServicesFXPPutResponse: { + /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */ + providers: components["schemas"]["FspId"][]; + }; + /** + * ServicesFXPSourceCurrencyTargetCurrencyPutResponse + * @description The object sent in the PUT /services/FXP/{SourceCurrency}/{TargetCurrency} callback. + */ + ServicesFXPSourceCurrencyTargetCurrencyPutResponse: { + /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */ + providers: components["schemas"]["FspId"][]; + }; + /** + * TokenCode + * @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z. + */ + TokenCode: string; + /** + * Transaction + * @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request. + */ + Transaction: { + transactionId: components["schemas"]["CorrelationId"]; + quoteId: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + amount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"] & unknown; + converter?: components["schemas"]["CurrencyConverter"] & unknown; + currencyConversion?: components["schemas"]["FxRate"] & unknown; + transactionType: components["schemas"]["TransactionType"]; + note?: components["schemas"]["Note"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionInitiator + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * @example PAYEE + * @enum {string} + */ + TransactionInitiator: "PAYER" | "PAYEE"; + /** + * TransactionInitiatorType + * @description Below are the allowed values for the enumeration. + * - CONSUMER - Consumer is the initiator of the transaction. + * - AGENT - Agent is the initiator of the transaction. + * - BUSINESS - Business is the initiator of the transaction. + * - DEVICE - Device is the initiator of the transaction. + * @example CONSUMER + * @enum {string} + */ + TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** + * TransactionRequestState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. + * - PENDING - Payer FSP has sent the transaction request to the Payer. + * - ACCEPTED - Payer has approved the transaction. + * - REJECTED - Payer has rejected the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * TransactionRequestsIDPutResponse + * @description The object sent in the PUT /transactionRequests/{ID} callback. + */ + TransactionRequestsIDPutResponse: { + transactionId?: components["schemas"]["CorrelationId"]; + transactionRequestState: components["schemas"]["TransactionRequestState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionRequestsPostRequest + * @description The object sent in the POST /transactionRequests request. + */ + TransactionRequestsPostRequest: { + transactionRequestId: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["PartyIdInfo"]; + amount: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + note?: components["schemas"]["Note"]; + geoCode?: components["schemas"]["GeoCode"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + expiration?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionScenario + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. + * - 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. + * - REFUND - Used for performing a refund of transaction. + * @example DEPOSIT + * @enum {string} + */ + TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; + /** + * TransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. + * - PENDING - Payee FSP has validated the transaction. + * - COMPLETED - Payee FSP has successfully performed the transaction. + * - REJECTED - Payee FSP has failed to perform the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + /** + * TransactionType + * @description Data model for the complex type TransactionType. + */ + TransactionType: { + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + refundInfo?: components["schemas"]["Refund"]; + balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; + }; + /** + * TransactionsIDPutResponse + * @description The object sent in the PUT /transactions/{ID} callback. + */ + TransactionsIDPutResponse: { + completedTimestamp?: components["schemas"]["DateTime"]; + transactionState: components["schemas"]["TransactionState"]; + code?: components["schemas"]["Code"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @example RESERVED + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** + * TransfersIDPatchResponse + * @description PATCH /transfers/{ID} object + */ + TransfersIDPatchResponse: { + completedTimestamp: components["schemas"]["DateTime"]; + transferState: components["schemas"]["TransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransfersIDPutResponse + * @description The object sent in the PUT /transfers/{ID} callback. + */ + TransfersIDPutResponse: { + fulfilment?: components["schemas"]["IlpFulfilment"]; + completedTimestamp?: components["schemas"]["DateTime"]; + transferState: components["schemas"]["TransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransfersPostRequest + * @description The object sent in the POST /transfers request. + */ + TransfersPostRequest: { + transferId: components["schemas"]["CorrelationId"]; + payeeFsp: components["schemas"]["FspId"]; + payerFsp: components["schemas"]["FspId"]; + amount: components["schemas"]["Money"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * U2FPIN + * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. + * + */ + U2FPIN: string; + /** + * U2FPinValue + * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. + * + */ + U2FPinValue: { + /** @description U2F challenge-response. */ + pinValue: components["schemas"]["U2FPIN"]; + /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */ + counter: components["schemas"]["Integer"]; + }; + /** + * UndefinedEnum + * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_). + */ + UndefinedEnum: string; }; responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Method Not Allowed */ + 405: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Acceptable */ + 406: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Implemented */ + 501: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Service Unavailable */ + 503: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - ParticipantsByIDAndType: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsSubIdByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsSubIdByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - ParticipantsSubIdByTypeAndIDPost: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsSubIdByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsSubIdErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - Participants1: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - putParticipantsByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - ParticipantsByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - PartiesByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - PartiesByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Party information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. - */ - PartiesErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up party information - * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). - */ - PartiesSubIdByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information - * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. - */ - PartiesSubIdByTypeAndIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Party information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return party information error - * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. - */ - PartiesSubIdErrorByTypeAndID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform transaction request - * @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server. - */ - TransactionRequests: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Transaction request to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionRequestsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transaction request information - * @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request. - */ - TransactionRequestsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction request information - * @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - TransactionRequestsByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transaction request information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionRequestsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction request information error - * @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`. - */ - TransactionRequestsErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate quote - * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. - */ - Quotes: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["QuotesPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve quote information - * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. - */ - QuotesByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return quote information - * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - QuotesByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["QuotesIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return quote information error - * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. - */ - QuotesByIDAndError: { parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform authorization - * @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:* - * - * - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`. - * - * - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected. - * - * - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`. - * - * - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`. - * - * The following is an example URI containing all the required key-value pairs in the query string*:* - * - * `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD` - */ - AuthorizationsByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return authorization result - * @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request. - */ - AuthorizationsByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Authorization result returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["AuthorizationsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return authorization error - * @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`. - */ - AuthorizationsByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform transfer - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. - */ - transfers: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transfer information - * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. - */ - TransfersByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information - * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. - */ - TransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information - * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. - */ - TransfersByIDPatch: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer notification upon completion. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransfersIDPatchResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transfer information error - * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. - */ - TransfersByIDAndError: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve transaction information - * @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process). - */ - TransactionsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction information - * @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - TransactionsByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transaction information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["TransactionsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return transaction information error - * @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request. - */ - TransactionsErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate bulk quote - * @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server. - */ - BulkQuotes: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the bulk quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkQuotesPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve bulk quote information - * @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote. - */ - BulkQuotesByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk quote information - * @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - BulkQuotesByID1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Bulk quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkQuotesIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk quote information error - * @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request. - */ - BulkQuotesErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform bulk transfer - * @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server. - */ - BulkTransfers: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the bulk transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkTransfersPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve bulk transfer information - * @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer. - */ - BulkTransferByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk transfer information - * @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - BulkTransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Bulk transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["BulkTransfersIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk transfer information error - * @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request. - */ - BulkTransfersErrorByID: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Calculate FX quote - * @description The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion. - */ - FxQuotesPost: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the FX quote to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxQuotesPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve FX quote information - * @description The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote. - */ - FxQuotesByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return FX quote information - * @description The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. - */ - FxQuotesByIdPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description FX Quote information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxQuotesIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return FX quote information error - * @description If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. - */ - FxQuotesByIDAndErrorPut: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Perform FX transfer - * @description The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion. - */ - FxTransfersPost: { - parameters: { - header: { - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - /** @description Details of the FX transfer to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxTransfersPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Retrieve FX transfer information - * @description The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer. - */ - FxTransfersByIDGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return FX transfer information - * @description The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request. - */ - FxTransfersByIDPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxTransfersIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return FX transfer information - * @description The HTTP request PATCH /fxTransfers/ is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback. - */ - FxTransfersByIDPatch: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Transfer notification upon completion. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxTransfersIDPatchResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return FX transfer information error - * @description If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. - */ - FxTransfersByIDAndErrorPut: { - parameters: { - header: { - "Content-Length"?: components["parameters"]["Content-Length"]; - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services. - */ - ServicesFXPGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** @description The callback `PUT /services/FXP` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. */ - ServicesFXPPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - /** @description The list of participant(s) who offer currency conversion services. */ - requestBody: { - content: { - "application/json": components["schemas"]["ServicesFXPPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @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. - */ - ServicesFXPSourceCurrencyTargetCurrencyGet: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - SourceCurrency: components["parameters"]["SourceCurrency"]; - TargetCurrency: components["parameters"]["TargetCurrency"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** @description The callback `PUT /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency. */ - ServicesFXPSourceCurrencyTargetCurrencyPut: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - SourceCurrency: components["parameters"]["SourceCurrency"]; - TargetCurrency: components["parameters"]["TargetCurrency"]; - }; - }; - /** @description The list of participant(s) who offer currency conversion services. */ - requestBody: { - content: { - "application/json": components["schemas"]["ServicesFXPSourceCurrencyTargetCurrencyPutResponse"]; - }; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: string; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: string; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination": string; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption": string; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method": string; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature": string; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": string; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI": string; + /** @description The identifier value. */ + ID: string; + /** @description ISO 4217 currency code for the source currency. */ + SourceCurrency: string; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: string; + /** @description ISO 4217 currency code for the target currency. */ + TargetCurrency: string; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For": string; + }; + requestBodies: never; + headers: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + }; + pathItems: never; +} +export type $defs = Record; +export interface operations { + ParticipantsByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByIDAndType: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndIDPost: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + Participants1: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + putParticipantsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdByTypeAndIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PartiesTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequests: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Transaction request to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionRequestsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequestsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequestsByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transaction request information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionRequestsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionRequestsErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + Quotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["QuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["QuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + AuthorizationsByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + AuthorizationsByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Authorization result returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["AuthorizationsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + AuthorizationsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + transfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDPatch: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer notification upon completion. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransfersIDPatchResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionsByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transaction information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TransactionsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransactionsErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the bulk quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkQuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Bulk quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkQuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkQuotesErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the bulk transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkTransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransferByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Bulk transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["BulkTransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + BulkTransfersErrorByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesPost: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the FX quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxQuotesPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesByIdPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description FX Quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxQuotesIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesByIDAndErrorPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersPost: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the FX transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDPatch: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer notification upon completion. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersIDPatchResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDAndErrorPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ServicesFXPGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ServicesFXPPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + /** @description The list of participant(s) who offer currency conversion services. */ + requestBody: { + content: { + "application/json": components["schemas"]["ServicesFXPPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ServicesFXPSourceCurrencyTargetCurrencyGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description ISO 4217 currency code for the source currency. */ + SourceCurrency: components["parameters"]["SourceCurrency"]; + /** @description ISO 4217 currency code for the target currency. */ + TargetCurrency: components["parameters"]["TargetCurrency"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ServicesFXPSourceCurrencyTargetCurrencyPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description ISO 4217 currency code for the source currency. */ + SourceCurrency: components["parameters"]["SourceCurrency"]; + /** @description ISO 4217 currency code for the target currency. */ + TargetCurrency: components["parameters"]["TargetCurrency"]; + }; + cookie?: never; + }; + /** @description The list of participant(s) who offer currency conversion services. */ + requestBody: { + content: { + "application/json": components["schemas"]["ServicesFXPSourceCurrencyTargetCurrencyPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; } diff --git a/src/fspiop/v2_0/schemas.ts b/src/fspiop/v2_0/schemas.ts index 4dc259ab..43752f46 100644 --- a/src/fspiop/v2_0/schemas.ts +++ b/src/fspiop/v2_0/schemas.ts @@ -87,8 +87,7 @@ export namespace Schemas { export const Refund = JsonSchemas.Refund export const RefundReason = JsonSchemas.RefundReason export const ServicesFXPPutResponse = JsonSchemas.ServicesFXPPutResponse - export const ServicesFXPSourceCurrencyTargetCurrencyPutResponse = - JsonSchemas.ServicesFXPSourceCurrencyTargetCurrencyPutResponse + export const ServicesFXPSourceCurrencyTargetCurrencyPutResponse = JsonSchemas.ServicesFXPSourceCurrencyTargetCurrencyPutResponse export const TokenCode = JsonSchemas.TokenCode export const Transaction = JsonSchemas.Transaction export const TransactionInitiator = JsonSchemas.TransactionInitiator diff --git a/src/fspiop/v2_0/types.ts b/src/fspiop/v2_0/types.ts index 0d14f608..2c5a99e8 100644 --- a/src/fspiop/v2_0/types.ts +++ b/src/fspiop/v2_0/types.ts @@ -87,8 +87,7 @@ export namespace Types { export type Refund = components['schemas']['Refund'] export type RefundReason = components['schemas']['RefundReason'] export type ServicesFXPPutResponse = components['schemas']['ServicesFXPPutResponse'] - export type ServicesFXPSourceCurrencyTargetCurrencyPutResponse = - components['schemas']['ServicesFXPSourceCurrencyTargetCurrencyPutResponse'] + export type ServicesFXPSourceCurrencyTargetCurrencyPutResponse = components['schemas']['ServicesFXPSourceCurrencyTargetCurrencyPutResponse'] export type TokenCode = components['schemas']['TokenCode'] export type Transaction = components['schemas']['Transaction'] export type TransactionInitiator = components['schemas']['TransactionInitiator'] diff --git a/src/fspiop/v2_0_ISO20022/index.ts b/src/fspiop/v2_0_ISO20022/index.ts new file mode 100644 index 00000000..860a6551 --- /dev/null +++ b/src/fspiop/v2_0_ISO20022/index.ts @@ -0,0 +1,5 @@ +/* eslint-disable @typescript-eslint/no-namespace */ + +export * as openapi from './openapi' +export * from './schemas' +export * from './types' diff --git a/src/fspiop/v2_0_ISO20022/json-schemas.json b/src/fspiop/v2_0_ISO20022/json-schemas.json new file mode 100644 index 00000000..32489a8f --- /dev/null +++ b/src/fspiop/v2_0_ISO20022/json-schemas.json @@ -0,0 +1,107991 @@ +{ + "AccountIdentification4Choice": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "AccountSchemeName1Choice": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "ActiveCurrencyAndAmount_SimpleType": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "ActiveCurrencyCode": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + }, + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "ActiveOrHistoricCurrencyAndAmount_SimpleType": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "ActiveOrHistoricCurrencyCode": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "AddressType2Code": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "AddressType3Choice": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "AnyBICDec2014Identifier": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "BICFIDec2014Identifier": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "BaseOneRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "BranchAndFinancialInstitutionIdentification6": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "BranchAndFinancialInstitutionIdentification8": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "BranchData3": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + }, + "BranchData5": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + }, + "CashAccount40": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "CashAccountType2Choice": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "CategoryPurpose1Choice": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + }, + "ChargeBearerType1Code": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChargeType3Choice": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + }, + "Charges16": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "ClearingChannel2Code": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "ClearingSystemIdentification2Choice": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "ClearingSystemMemberIdentification2": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "Contact13": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + }, + "Contact4": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + }, + "CountryCode": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CreditTransferTransaction67": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + }, + "CreditTransferTransaction68": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dbtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + }, + "CryptographicLockChoice": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + }, + "DateAndPlaceOfBirth1": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "DatePeriod2": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + }, + "ErrorCode": { + "title": "ErrorCode", + "type": "string", + "pattern": "^[1-9]\\d{3}$", + "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", + "example": "5100" + }, + "ErrorDescription": { + "title": "ErrorDescription", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Error description string." + }, + "ErrorInformation": { + "title": "ErrorInformation", + "type": "object", + "description": "Data model for the complex type ErrorInformation.", + "properties": { + "errorCode": { + "title": "ErrorCode", + "type": "string", + "pattern": "^[1-9]\\d{3}$", + "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", + "example": "5100" + }, + "errorDescription": { + "title": "ErrorDescription", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Error description string." + }, + "extensionList": { + "title": "ExtensionList", + "type": "object", + "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n", + "properties": { + "extension": { + "type": "array", + "items": { + "title": "Extension", + "type": "object", + "description": "Data model for the complex type Extension.", + "properties": { + "key": { + "title": "ExtensionKey", + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "Extension key." + }, + "value": { + "title": "ExtensionValue", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Extension value." + } + }, + "required": [ + "key", + "value" + ] + }, + "minItems": 1, + "maxItems": 16, + "description": "Number of Extension elements." + } + }, + "required": [ + "extension" + ] + } + }, + "required": [ + "errorCode", + "errorDescription" + ] + }, + "ErrorInformationResponse": { + "title": "ErrorInformationResponse", + "type": "object", + "description": "Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.\n", + "properties": { + "errorInformation": { + "title": "ErrorInformation", + "type": "object", + "description": "Data model for the complex type ErrorInformation.", + "properties": { + "errorCode": { + "title": "ErrorCode", + "type": "string", + "pattern": "^[1-9]\\d{3}$", + "description": "The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.", + "example": "5100" + }, + "errorDescription": { + "title": "ErrorDescription", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Error description string." + }, + "extensionList": { + "title": "ExtensionList", + "type": "object", + "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n", + "properties": { + "extension": { + "type": "array", + "items": { + "title": "Extension", + "type": "object", + "description": "Data model for the complex type Extension.", + "properties": { + "key": { + "title": "ExtensionKey", + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "Extension key." + }, + "value": { + "title": "ExtensionValue", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Extension value." + } + }, + "required": [ + "key", + "value" + ] + }, + "minItems": 1, + "maxItems": 16, + "description": "Number of Extension elements." + } + }, + "required": [ + "extension" + ] + } + }, + "required": [ + "errorCode", + "errorDescription" + ] + } + } + }, + "Exact32HexBinaryText": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "Exact4AlphaNumericText": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Execute_FIToFICustomerCreditTransferV13": { + "title": "Execute_FIToFICustomerCreditTransferV13", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader129", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "PmtInstrXpryDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": 123 + } + }, + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123, + "EndToEndId": 123 + }, + "PmtTpInf": { + "InstrPrty": "NORM" + }, + "InstdAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], + "example": { + "GrpHdr": { + "MsgId": 123456789, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": 91 + } + } + ] + } + } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BBBBBBBB" + } + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123456789, + "EndToEndId": 123456789 + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": { + "Cd": "SUPP" + } + }, + "InstrForCdtrAgt": { + "FinInstnId": { + "BICFI": "AAAAAAAA" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "AAAAAAAA" + } + }, + "Cdtr": { + "Nm": "Creditor Name", + "PstlAdr": { + "AdrLine": [ + "Creditor Address Line 1", + "Creditor Address Line 2", + "Creditor Address Line 3", + "Creditor Address Line 4", + "Creditor Address Line 5" + ] + }, + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": 91 + } + } + ] + } + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "DE87123456781234567890" + } + }, + "RmtInf": { + "Ustrd": "Remittance Information" + } + } + } + }, + "Extension": { + "title": "Extension", + "type": "object", + "description": "Data model for the complex type Extension.", + "properties": { + "key": { + "title": "ExtensionKey", + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "Extension key." + }, + "value": { + "title": "ExtensionValue", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Extension value." + } + }, + "required": [ + "key", + "value" + ] + }, + "ExtensionKey": { + "title": "ExtensionKey", + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "Extension key." + }, + "ExtensionList": { + "title": "ExtensionList", + "type": "object", + "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.\n", + "properties": { + "extension": { + "type": "array", + "items": { + "title": "Extension", + "type": "object", + "description": "Data model for the complex type Extension.", + "properties": { + "key": { + "title": "ExtensionKey", + "type": "string", + "minLength": 1, + "maxLength": 32, + "description": "Extension key." + }, + "value": { + "title": "ExtensionValue", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Extension value." + } + }, + "required": [ + "key", + "value" + ] + }, + "minItems": 1, + "maxItems": 16, + "description": "Number of Extension elements." + } + }, + "required": [ + "extension" + ] + }, + "ExtensionValue": { + "title": "ExtensionValue", + "type": "string", + "minLength": 1, + "maxLength": 128, + "description": "Extension value." + }, + "ExternalAccountIdentification1Code": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalCashAccountType1Code": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalCategoryPurpose1Code": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "ExternalChargeType1Code": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalClearingSystemIdentification1Code": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "ExternalCreditorAgentInstruction1Code": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalFinancialInstitutionIdentification1Code": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalLocalInstrument1Code": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "ExternalOrganisationIdentification1Code": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalPaymentTransactionStatus1Code": { + "title": "ExternalPaymentTransactionStatus1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalPersonIdentification1Code": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalProxyAccountType1Code": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalPurpose1Code": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalServiceLevel1Code": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalStatusReason1Code": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "ExternalVerificationReason1Code": { + "title": "ExternalVerificationReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "FinancialIdentificationSchemeName1Choice": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "FinancialInstitutionIdentification18": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "FinancialInstitutionIdentification23": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "FxRequest_FICreditTransferProposal": { + "title": "FxRequest_FICreditTransferProposal", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader113", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "TtlIntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dbtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "TtlIntrBkSttlmAmt": { + "Ccy": "EUR", + "Value": 100 + }, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "SttlmAcctOwnr": { + "Nm": "Name" + }, + "SttlmAcctSvcr": { + "Nm": "Name" + }, + "SttlmAgt": { + "FinInstnId": { + "BICFI": "BIC" + } + } + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": "CASH" + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 12345, + "EndToEndId": 12345 + }, + "Amt": { + "InstdAmt": { + "Ccy": "EUR", + "Value": 100 + } + }, + "Cdtr": { + "Nm": "Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BIC" + } + }, + "CdtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + } + }, + "required": [ + "GrpHdr" + ], + "example": { + "GrpHdr": { + "MsgId": 123456789, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BIC" + } + } + ] + } + } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BICFID0" + } + }, + "Dbtr": { + "Nm": "Debtor Name", + "PstlAdr": { + "AdrLine": [ + "Debtor Address Line 1", + "Debtor Address Line 2" + ] + }, + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BIC" + } + } + ] + } + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFID0" + } + }, + "Cdtr": { + "Nm": "Creditor Name", + "PstlAdr": { + "AdrLine": [ + "Creditor Address Line 1", + "Creditor Address Line 2" + ] + }, + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BIC" + } + } + ] + } + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFID0" + } + }, + "CdtTrfTxInf": [ + { + "PmtId": { + "InstrId": 123456789, + "EndToEndId": 123456789 + }, + "Amt": { + "InstdAmt": { + "Ccy": "EUR", + "Amt": 100 + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFID0" + } + }, + "Cdtr": { + "Nm": "Creditor Name", + "PstlAdr": { + "AdrLine": [ + "Creditor Address Line 1", + "Creditor Address Line 2" + ] + }, + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BIC" + } + } + ] + } + } + } + } + ] + } + } + }, + "FxResponse_FICreditTransferConfirmation": { + "title": "FxResponse_FICreditTransferConfirmation", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader113", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "TtlIntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dbtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "TtlIntrBkSttlmAmt": { + "Ccy": "EUR", + "Value": 100 + }, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "SttlmAcctOwnr": { + "Nm": "Name" + }, + "SttlmAcctSvcr": { + "Nm": "Name" + }, + "SttlmAgt": { + "FinInstnId": { + "BICFI": "BIC" + } + } + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": "CASH" + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 12345, + "EndToEndId": 12345 + }, + "Amt": { + "InstdAmt": { + "Ccy": "EUR", + "Value": 100 + } + }, + "Cdtr": { + "Nm": "Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BIC" + } + }, + "CdtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dbtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], + "example": { + "GrpHdr": { + "MsgId": "20191122-123456", + "CreDtTm": "2019-11-22T12:34:56", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name" + }, + "MsgRcpt": { + "Nm": "Message Recipient Name" + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": "20191122-123456", + "EndToEndId": "20191122-123456" + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": "SUPP" + }, + "IntrBkSttlmAmt": { + "Amt": 100, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BNBABEBB" + } + }, + "CdtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BNBABEBB" + } + }, + "DbtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + }, + "RmtInf": { + "Ustrd": "Remittance Information" + }, + "RgltryRptg": { + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account" + } + } + } + } + }, + "Fxecute_FinancialInstitutionCreditTransferV12": { + "title": "Fxecute_FinancialInstitutionCreditTransferV12", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader129", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "PmtInstrXpryDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": 123 + } + }, + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123, + "EndToEndId": 123 + }, + "PmtTpInf": { + "InstrPrty": "NORM" + }, + "InstdAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dbtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], + "example": { + "GrpHdr": { + "MsgId": 20191113001, + "CreDtTm": "2019-11-13T10:00:00", + "NbOfTxs": 1, + "CtrlSum": 1000, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": { + "Id": 123456789, + "SchmeNm": { + "Cd": "BBA" + } + } + } + } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BBBBBBBB" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "AAAAAAAA" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "CCCCCCCC" + } + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 20191113001, + "EndToEndId": 20191113001 + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": { + "Cd": "SUPP" + } + }, + "InstrForCdtrAgt": { + "Cd": "/ACC/123456789" + }, + "IntrBkSttlmAmt": { + "Amt": 1000, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": "CCCCCCCC" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + } + }, + "RmtInf": { + "Ustrd": "Payment for invoice 12345" + } + } + } + }, + "GenericAccountIdentification1": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "GenericFinancialIdentification1": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "GenericIdentification3": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + }, + "GenericIdentification30": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + }, + "GenericOrganisationIdentification1": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + "GenericOrganisationIdentification3": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + }, + "GenericPersonIdentification1": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + }, + "GenericPersonIdentification2": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + }, + "GetPartiesError_IdentificationVerificationReportV03": { + "title": "GetPartiesError_IdentificationVerificationReportV03", + "type": "object", + "properties": { + "Assgnmt": { + "title": "IdentificationAssignment3", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "Assgnr": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + }, + "Assgne": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "Assgnr", + "Assgne" + ], + "example": { + "MsgId": 123, + "CreDtTm": "2020-01-01T00:00:00Z", + "Assgnr": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "Assgne": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + } + } + }, + "Rpt": { + "title": "VerificationReport4", + "type": "object", + "properties": { + "OrgnlId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Vrfctn": { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true + }, + "Rsn": { + "title": "VerificationReason1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalVerificationReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "OrgnlPtyAndAcctId": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + "UpdtdPtyAndAcctId": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + } + }, + "required": [ + "OrgnlId", + "Vrfctn" + ], + "example": { + "OrgnlId": 123456789, + "Vrfctn": true, + "Rsn": { + "Cd": "AGNT" + }, + "OrgnlPtyAndAcctId": { + "Id": 123456789, + "SchmeNm": { + "Cd": "CCPT" + } + }, + "UpdtdPtyAndAcctId": { + "Id": 123456789, + "SchmeNm": { + "Cd": "CCPT" + } + } + } + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "required": [ + "Assgnmt", + "Rpt" + ], + "example": { + "Assgnmt": { + "Id": 123, + "CreDtTm": "2013-03-07T16:30:00", + "Assgnr": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "Assgne": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "Rpt": { + "Id": 123, + "CreDtTm": "2013-03-07T16:30:00", + "RptgPty": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "RptdPty": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "RptdDoc": { + "Nb": 123, + "RltdDt": "2013-03-07", + "RltdDtTp": { + "Cd": 123 + } + }, + "Rsn": { + "Cd": 123, + "Prtry": 123 + } + }, + "SplmtryData": { + "PlcAndNm": 123, + "Envlp": 123, + "RltdDt": "2013-03-07", + "RltdDtTp": { + "Cd": 123 + } + } + } + }, + "GetParties_IdentificationVerificationReportV03": { + "title": "GetParties_IdentificationVerificationReportV03", + "type": "object", + "properties": { + "Assgnmt": { + "title": "IdentificationAssignment3", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "Assgnr": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + }, + "Assgne": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "Assgnr", + "Assgne" + ], + "example": { + "MsgId": 123, + "CreDtTm": "2020-01-01T00:00:00Z", + "Assgnr": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "Assgne": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + } + } + }, + "Rpt": { + "title": "VerificationReport4", + "type": "object", + "properties": { + "OrgnlId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Vrfctn": { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true + }, + "Rsn": { + "title": "VerificationReason1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalVerificationReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "OrgnlPtyAndAcctId": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + "UpdtdPtyAndAcctId": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + } + }, + "required": [ + "OrgnlId", + "Vrfctn" + ], + "example": { + "OrgnlId": 123456789, + "Vrfctn": true, + "Rsn": { + "Cd": "AGNT" + }, + "OrgnlPtyAndAcctId": { + "Id": 123456789, + "SchmeNm": { + "Cd": "CCPT" + } + }, + "UpdtdPtyAndAcctId": { + "Id": 123456789, + "SchmeNm": { + "Cd": "CCPT" + } + } + } + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "required": [ + "Assgnmt", + "Rpt" + ], + "example": { + "Assgnmt": { + "Id": 123, + "CreDtTm": "2013-03-07T16:30:00", + "Assgnr": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "Assgne": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "Rpt": { + "Id": 123, + "CreDtTm": "2013-03-07T16:30:00", + "RptgPty": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "RptdPty": { + "Id": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + }, + "RptdDoc": { + "Nb": 123, + "RltdDt": "2013-03-07", + "RltdDtTp": { + "Cd": 123 + } + }, + "Rsn": { + "Cd": 123, + "Prtry": 123 + } + }, + "SplmtryData": { + "PlcAndNm": 123, + "Envlp": 123, + "RltdDt": "2013-03-07", + "RltdDtTp": { + "Cd": 123 + } + } + } + }, + "GroupHeader113": { + "title": "GroupHeader113", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "TtlIntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction68", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dbtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "Dbtr", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + } + }, + "IntrBkSttlmAmt": { + "Amount": 123.45, + "Ccy": "EUR" + }, + "Dbtr": { + "Nm": "Debtor Name" + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "Creditor Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "INSTRUCTION" + }, + "Purp": { + "Cd": "CHAR" + }, + "VrfctnOfTerms": { + "Cntt": "CONTENT", + "CnttTp": "PROPRIETARY" + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "TtlIntrBkSttlmAmt": { + "Ccy": "EUR", + "Value": 100 + }, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "SttlmAcctOwnr": { + "Nm": "Name" + }, + "SttlmAcctSvcr": { + "Nm": "Name" + }, + "SttlmAgt": { + "FinInstnId": { + "BICFI": "BIC" + } + } + }, + "PmtTpInf": { + "InstrPrty": "NORM", + "CtgyPurp": "CASH" + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 12345, + "EndToEndId": 12345 + }, + "Amt": { + "InstdAmt": { + "Ccy": "EUR", + "Value": 100 + } + }, + "Cdtr": { + "Nm": "Name" + }, + "CdtrAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "CdtrAgt": { + "FinInstnId": { + "BICFI": "BIC" + } + }, + "CdtrAgtAcct": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Ccy": "EUR" + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "GroupHeader120": { + "title": "GroupHeader120", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "TxInfAndSts": { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlInstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlEndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlTxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlUETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "TxSts": { + "title": "ExternalPaymentTransactionStatus1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "StsRsnInf": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Rsn": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "AddtlInf": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "AccptncDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "AcctSvcrRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ExctnConf": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "TxInfAndSts": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + } + }, + "GroupHeader129": { + "title": "GroupHeader129", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "PmtInstrXpryDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": 123 + } + }, + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123, + "EndToEndId": 123 + }, + "PmtTpInf": { + "InstrPrty": "NORM" + }, + "InstdAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "IBAN2007Identifier": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "ISODate": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ISODateTime": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "ISOYear": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "IdentificationAssignment3": { + "title": "IdentificationAssignment3", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "Assgnr": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + }, + "Assgne": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "Assgnr", + "Assgne" + ], + "example": { + "MsgId": 123, + "CreDtTm": "2020-01-01T00:00:00Z", + "Assgnr": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "Assgne": { + "OrgId": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + } + } + }, + "IdentificationInformation4": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + "IdentificationVerificationIndicator": { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true + }, + "Instruction4Code": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstructionForCreditorAgent3": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstructionForNextAgent1": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "LEIIdentifier": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "LocalInstrument2Choice": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Max105Text": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + }, + "Max10Text": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Max128Text": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + }, + "Max140Text": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Max15NumericText": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "Max16Text": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Max2048Text": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "Max256Text": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "Max34Text": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "Max350Text": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Max35Text": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Max4Text": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Max70Text": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "NamePrefix2Code": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Number": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "OrganisationIdentification29": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "OrganisationIdentification39": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "OrganisationIdentificationSchemeName1Choice": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "OtherContact1": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PacsError_FIToFIPaymentStatusReportV15": { + "title": "PacsError_FIToFIPaymentStatusReportV15", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader120", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "TxInfAndSts": { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlInstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlEndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlTxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlUETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "TxSts": { + "title": "ExternalPaymentTransactionStatus1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "StsRsnInf": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Rsn": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "AddtlInf": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "AccptncDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "AcctSvcrRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ExctnConf": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "TxInfAndSts": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + } + }, + "TxInfAndSts": { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlInstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlEndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlTxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlUETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "TxSts": { + "title": "ExternalPaymentTransactionStatus1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "StsRsnInf": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Rsn": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "AddtlInf": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "AccptncDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "AcctSvcrRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ExctnConf": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "required": [ + "GrpHdr" + ], + "example": { + "GrpHdr": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmDt": "2020-01-01" + }, + "InstgAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "InstdAgt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + }, + "TxInfAndSts": { + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + } + }, + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + "PacsStatus_FIToFIPaymentStatusReportV15": { + "title": "PacsStatus_FIToFIPaymentStatusReportV15", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader120", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "TxInfAndSts": { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlInstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlEndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlTxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlUETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "TxSts": { + "title": "ExternalPaymentTransactionStatus1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "StsRsnInf": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Rsn": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "AddtlInf": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "AccptncDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "AcctSvcrRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ExctnConf": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + } + }, + "required": [ + "MsgId", + "CreDtTm" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "TxInfAndSts": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + } + } + }, + "required": [ + "GrpHdr" + ], + "example": { + "GrpHdr": { + "MsgId": 123, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmDt": "2020-01-01", + "SttlmTmIndctn": "RTGS", + "SttlmTmReq": "2020-01-01T00:00:00Z", + "SttlmAcct": { + "Id": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "ClrSys": { + "Prtry": 123 + }, + "InstgAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "InstdAgt": { + "FinInstnId": { + "BICFI": 123 + } + } + }, + "InstgAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "InstdAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "IntrBkSttlmAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "IntrBkSttlmDt": "2020-01-01", + "TxSts": "ACCP", + "StsRsnInf": { + "Orgtr": { + "Id": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "Rsn": { + "Cd": 123, + "Prtry": 123 + } + }, + "TxInfAndSts": { + "OrgnlInstrId": 123, + "OrgnlEndToEndId": 123, + "TxSts": "ACCP", + "StsRsnInf": { + "Orgtr": { + "Id": { + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "Rsn": { + "Cd": 123, + "Prtry": 123 + } + }, + "ChrgsInf": { + "Amt": 123, + "Ccy": "EUR" + }, + "IntrBkSttlmAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "IntrBkSttlmDt": "2020-01-01", + "SttlmTmIndctn": "RTGS" + } + } + } + }, + "Party38Choice": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "Party40Choice": { + "title": "Party40Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "Pty" + ] + }, + { + "required": [ + "Agt" + ] + } + ], + "example": { + "Pty": { + "Nm": "Name", + "PstlAdr": { + "Ctry": "US", + "AdrLine": [ + "Line1", + "Line2" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + } + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + } + }, + "Party52Choice": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "PartyIdentification135": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "PartyIdentification272": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "PaymentIdentification13": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PaymentTransaction163": { + "title": "PaymentTransaction163", + "description": "Provides further details on the original transactions, to which the status report message refers.\n", + "type": "object", + "properties": { + "StsId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlInstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlEndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlTxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "OrgnlUETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "TxSts": { + "title": "ExternalPaymentTransactionStatus1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "StsRsnInf": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Rsn": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "AddtlInf": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "AccptncDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "AcctSvcrRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "ExctnConf": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + }, + "SplmtryData": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + } + }, + "example": { + "StsId": 12345, + "OrgnlInstrId": 12345, + "OrgnlEndToEndId": 12345, + "OrgnlTxId": 12345, + "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + "TxSts": "RJCT", + "StsRsnInf": { + "Rsn": "RSN", + "AddtlInf": "ADDITIONAL" + }, + "AccptncDtTm": "2020-01-01T00:00:00Z", + "AcctSvcrRef": "ACCTSVCRREF", + "ClrSysRef": "CLRSYSREF", + "ExctnConf": "1234567890ABCDEF", + "SplmtryData": { + "PlcAndNm": "PLACE", + "Envlp": "ENVELOPE" + } + } + }, + "PaymentTypeInformation28": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "PercentageRate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "PersonIdentification13": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + "PersonIdentification18": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + }, + "PersonIdentificationSchemeName1Choice": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "PhoneNumber": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "PostalAddress24": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "PostalAddress27": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "PreferredContactMethod1Code": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + }, + "PreferredContactMethod2Code": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + }, + "Priority2Code": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ProxyAccountIdentification1": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + }, + "ProxyAccountType1Choice": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Purpose2Choice": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RegulatoryAuthority2": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "RegulatoryReporting3": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "RegulatoryReportingType1Code": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "ServiceLevel8Choice": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "SettlementInstruction15": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "SettlementMethod1Code": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "StatusReason6Choice": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "StatusReasonInformation14": { + "title": "StatusReasonInformation14", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Orgtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Rsn": { + "title": "StatusReason6Choice", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalStatusReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "AddtlInf": { + "title": "Max105Text", + "description": "Specifies a character string with a maximum length of 105 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 105, + "example": 12345 + } + }, + "example": { + "Orgtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "SubDepartment", + "StrtNm": "StreetName", + "BldgNb": "BuildingNumber", + "PstCd": "PostCode", + "TwnNm": "TownName", + "CtrySubDvsn": "CountrySubDivision", + "Ctry": "Country" + } + }, + "Rsn": { + "Cd": "AGNT" + }, + "AddtlInf": "AdditionalInformation" + } + }, + "StructuredRegulatoryReporting3": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + }, + "SupplementaryData1": { + "title": "SupplementaryData1", + "description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n", + "type": "object", + "properties": { + "PlcAndNm": { + "title": "Max350Text", + "description": "Specifies a character string with a maximum length of 350 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 350, + "example": 350 + }, + "Envlp": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + } + }, + "required": [ + "Envlp" + ], + "example": { + "PlcAndNm": "Additional information", + "Envlp": { + "Cd": "CH03", + "Prtry": "Additional information" + } + } + }, + "SupplementaryDataEnvelope1": { + "title": "SupplementaryDataEnvelope1", + "description": "Unsure on description.\n", + "type": "object" + }, + "TaxAmount3": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "TaxAuthorisation1": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + }, + "TaxData1": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "TaxParty1": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "TaxParty2": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "TaxPeriod3": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxRecord3": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + }, + "TaxRecordDetails3": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + }, + "TaxRecordPeriod1Code": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "TermsRequest_FIToFICustomerCreditProposal": { + "title": "TermsRequest_FIToFICustomerCreditProposal", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader129", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "PmtInstrXpryDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": 123 + } + }, + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123, + "EndToEndId": 123 + }, + "PmtTpInf": { + "InstrPrty": "NORM" + }, + "InstdAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + } + }, + "required": [ + "GrpHdr" + ], + "example": { + "GrpHdr": { + "MsgId": 123456789, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BBA", + "Prtry": "Party Identification Scheme Name" + } + } + ] + } + } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BBBBBBBB" + } + } + } + } + }, + "TermsResponse_FIToFICustomerCreditConfirmation": { + "title": "TermsResponse_FIToFICustomerCreditConfirmation", + "type": "object", + "properties": { + "GrpHdr": { + "title": "GroupHeader129", + "description": "Set of characteristics shared by all individual transactions included in the message.\n", + "type": "object", + "properties": { + "MsgId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CreDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "PmtInstrXpryDtTm": { + "title": "ISODateTime", + "description": "A particular point in the progression of time defined by a mandatory\ndate and a mandatory time component, expressed in either UTC time\nformat (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format\n(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format\n(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in\n\"XML Schema Part 2: Datatypes Second Edition -\nW3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the\ninvolved parties shall agree on the maximum number of digits that are allowed.\n", + "type": "string", + "format": "datetime", + "example": "2013-03-07T14:44:30.000Z" + }, + "NbOfTxs": { + "title": "Max15NumericText", + "description": "Specifies a numeric string with a maximum length of 15 digits.\n", + "type": "string", + "pattern": "^[0-9]{1,15}$", + "example": 123456789012345 + }, + "SttlmInf": { + "title": "SettlementInstruction15", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "SttlmMtd": { + "title": "SettlementMethod1Code", + "description": "Specifies the method used to settle the credit transfer instruction.\n", + "type": "string", + "enum": [ + "INDA", + "INGA", + "COVE", + "CLRG" + ], + "example": "CLRG" + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + } + }, + "required": [ + "SttlmMtd" + ], + "example": { + "SttlmMtd": "INDA", + "PmtTpInf": { + "InstrPrty": "NORM", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CH03" + }, + "CtgyPurp": { + "Cd": "SUPP" + }, + "Cdtr": { + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "AdrLine": "Address", + "Ctry": "CH" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN", + "Issr": "BIC" + } + } + } + }, + "CtryOfRes": "CH", + "CtctDtls": { + "Nm": "Name", + "PhneNb": 123, + "EmailAdr": null + } + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "MsgId", + "CreDtTm", + "NbOfTxs", + "SttlmInf", + "CdtTrfTxInf" + ], + "example": { + "MsgId": 12345, + "CreDtTm": "2020-01-01T00:00:00Z", + "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "SttlmInf": { + "SttlmMtd": "INDA", + "SttlmAcct": { + "Id": { + "IBAN": 123 + } + }, + "SttlmAcctOwnr": { + "Nm": "John Doe" + }, + "SttlmAcctSvcr": { + "BICFI": 123 + } + }, + "CdtTrfTxInf": { + "PmtId": { + "InstrId": 123, + "EndToEndId": 123 + }, + "PmtTpInf": { + "InstrPrty": "NORM" + }, + "InstdAmt": { + "Amt": 123, + "Ccy": "EUR" + }, + "ChrgBr": "SLEV", + "CdtrAgt": { + "FinInstnId": { + "BICFI": 123 + } + }, + "Cdtr": { + "Nm": "John Doe" + }, + "CdtrAcct": { + "Id": { + "IBAN": 123 + } + }, + "RmtInf": { + "Ustrd": "Test" + } + } + } + }, + "CdtTrfTxInf": { + "title": "CreditTransferTransaction67", + "description": "Provides further details specific to the individual transaction(s) included in the message.\n", + "type": "object", + "properties": { + "PmtId": { + "title": "PaymentIdentification13", + "description": "Provides further means of referencing a payment transaction.\n", + "type": "object", + "properties": { + "InstrId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "EndToEndId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "UETR": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "ClrSysRef": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "EndToEndId" + ], + "example": { + "InstrId": "INSTRUCTIONID", + "EndToEndId": "ENDTOENDID", + "TxId": "TRANSACTIONID", + "UETR": "123e4567-e89b-12d3-a456-426614174000", + "ClrSysRef": "CLRSYSREF" + } + }, + "PmtTpInf": { + "title": "PaymentTypeInformation28", + "description": "Provides further details of the type of payment.\n", + "type": "object", + "properties": { + "InstrPrty": { + "title": "Priority2Code", + "description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.\n", + "type": "string", + "enum": [ + "HIGH", + "NORM" + ], + "example": "HIGH" + }, + "ClrChanl": { + "title": "ClearingChannel2Code", + "description": "Specifies the clearing channel for the routing of the transaction, as part of the payment type identification.\nRTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system.\nRTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system.\nMPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system.\nBOOK BookTransfer Payment through internal book transfer.\n", + "type": "string", + "enum": [ + "RTGS", + "RTNS", + "MPNS", + "BOOK" + ], + "example": "RTGS" + }, + "SvcLvl": { + "title": "ServiceLevel8Choice", + "description": "Details about a service level.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalServiceLevel1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "SEPA" + } + }, + "LclInstrm": { + "title": "LocalInstrument2Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalLocalInstrument1Code", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "CtgyPurp": { + "title": "CategoryPurpose1Choice", + "description": "Contains details about high level purpose of the mandate based on a set of pre-defined categories.\n", + "type": "object", + "properties": { + "Cd": { + "description": "Specifies the category purpose, as published in an external category purpose code list.\nExternal code sets can be downloaded from www.iso20022.org.\n", + "maxLength": 4, + "minLength": 1, + "type": "string", + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "example": { + "InstrPrty": "NORM", + "ClrChanl": "RTGS", + "SvcLvl": { + "Cd": "SEPA" + }, + "LclInstrm": { + "Cd": "CORE" + }, + "CtgyPurp": { + "Cd": "CASH" + } + } + }, + "IntrBkSttlmAmt": { + "title": "ActiveCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveCurrencyAndAmount": { + "title": "ActiveCurrencyAndAmount_SimpleType", + "type": "string", + "description": "NOTE: This regex doesn't seem correct given it's xsd definition.\n\n \n \n \n \n \n\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveCurrencyCode", + "type": "string", + "pattern": "^[A-Z]{3,3}$", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".", + "example": "USD" + } + }, + "required": [ + "ActiveCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "InstdAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "XchgRate": { + "title": "BaseOneRate", + "type": "string", + "description": "Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.\n", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 0.7 + }, + "ChrgBr": { + "title": "ChargeBearerType1Code", + "description": "Specifies which party(ies) will pay charges due for processing of the instruction.\nDEBT BorneByDebtor All transaction charges are to be borne by the debtor.\nCRED BorneByCreditor All transaction charges are to be borne by the creditor.\nSHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver\nSLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level.\n", + "type": "string", + "enum": [ + "DEBT", + "CRED", + "SHAR", + "SLEV" + ], + "example": "DEBT" + }, + "ChrgsInf": { + "title": "Charges16", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Tp": { + "title": "ChargeType3Choice", + "description": "ChargeType3Choice Specifies the type of charge.", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalChargeType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "GenericIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CASH" + } + } + }, + "required": [ + "Amt", + "Agt" + ], + "example": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + } + }, + "Dbtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "DbtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "DbtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "CdtrAgt": { + "title": "BranchAndFinancialInstitutionIdentification8", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification23", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData5", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "BUKBGB22" + }, + "BrnchId": { + "Id": 12345, + "Nm": "Oxford Street Branch", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Oxford Street", + "London", + "UK" + ] + } + } + } + }, + "Cdtr": { + "title": "PartyIdentification272", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress27", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "CareOf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "UnitNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "TwnLctnNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "DstrctNm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "CareOf": "CareOf", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "UnitNb": "UnitNb", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party52Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification39", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification3", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification18", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification2", + "type": "object", + "properties": { + "Id": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact13", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "URLAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailAdr": { + "title": "Max256Text", + "description": "Specifies a character string with a maximum length of 256 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 256, + "example": 256 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod2Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "MAIL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "URLAdr": "http://www.example.com", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry" + }, + "Id": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "CdtrAcct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "InstrForCdtrAgt": { + "title": "InstructionForCreditorAgent3", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCreditorAgentInstruction1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone." + } + }, + "InstrForNxtAgt": { + "title": "InstructionForNextAgent1", + "description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.\n", + "type": "object", + "properties": { + "Cd": { + "title": "Instruction4Code", + "description": "Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s).\nPHOA PhoneNextAgent Please advise/contact next agent by phone.\nTELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication.\n", + "type": "string", + "enum": [ + "PHOA", + "TELA" + ], + "example": "PHOA" + }, + "InstrInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Cd": "PHOA", + "InstrInf": "Please advise/contact next agent by phone" + } + }, + "Purp": { + "title": "Purpose2Choice", + "description": "Specifies the underlying reason for the payment transaction.\nUsage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPurpose1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "RgltryRptg": { + "title": "RegulatoryReporting3", + "description": "Information needed due to regulatory and/or statutory requirements.\n", + "type": "object", + "properties": { + "DbtCdtRptgInd": { + "title": "RegulatoryReportingType1Code", + "description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.\n", + "type": "string", + "enum": [ + "CRED", + "DEBT", + "BOTH" + ], + "example": "BOTH" + }, + "Authrty": { + "title": "RegulatoryAuthority2", + "description": "Information about an entity requiring the regulatory reporting information.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "example": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + } + }, + "Dtls": { + "title": "StructuredRegulatoryReporting3", + "description": "Unsure on description.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "Cd": { + "title": "Max10Text", + "description": "Specifies a character string with a maximum length of 10 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 10, + "example": 1234567890 + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Inf": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "Tp": "T1", + "Dt": "2018-01-01", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "example": { + "DbtCdtRptgInd": "CRED", + "Authrty": { + "Nm": "Swiss National Bank", + "Ctry": "CH" + }, + "Dtls": { + "Cd": "A1", + "Inf": "Mandatory regulatory information" + } + } + }, + "Tax": { + "title": "TaxData1", + "description": "Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account.\n", + "type": "object", + "properties": { + "Cdtr": { + "title": "TaxParty1", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT" + } + }, + "Dbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "UltmtDbtr": { + "title": "TaxParty2", + "description": "Details about the entity involved in the tax paid or to be paid.\n", + "type": "object", + "properties": { + "TaxId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RegnId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TaxTp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Authstn": { + "title": "TaxAuthorisation1", + "description": "Details of an authorised tax paying party.\n", + "type": "object", + "properties": { + "Titl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "example": { + "TaxId": 123456789, + "RegnId": 123456789, + "TaxTp": "VAT", + "Authstn": { + "Titl": "Mr", + "Nm": "John Doe" + } + } + }, + "AdmstnZone": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "RefNb": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "Mtd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TtlTaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlTaxAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "SeqNb": { + "title": "Number", + "type": "string", + "pattern": "^[\\d\\-\\.\\,]{1,18}$", + "example": 256 + }, + "Rcrd": { + "title": "TaxRecord3", + "description": "Set of elements used to define the tax record.\n", + "type": "object", + "properties": { + "Tp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctgy": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtgyDtls": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DbtrSts": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CertId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "FrmsCd": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "TaxAmt": { + "title": "TaxAmount3", + "description": "Information on the amount of the tax record.\n", + "type": "object", + "properties": { + "Rate": { + "title": "PercentageRate", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,11}$)([\\d\\-\\,\\.]{1,10})?$", + "example": 1234 + }, + "TaxblBaseAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "TtlAmt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + }, + "Dtls": { + "title": "TaxRecordDetails3", + "description": "Details on the tax period and amount\n", + "type": "object", + "properties": { + "Prd": { + "title": "TaxPeriod3", + "description": "Period of time details related to the tax payment.\n", + "type": "object", + "properties": { + "Yr": { + "title": "ISOYear", + "description": "Year represented by YYYY (ISO 8601).\n", + "type": "string", + "pattern": "^\\d{4}(Z|([+-]\\d{2}:\\d{2})){0,1}$", + "example": 2019 + }, + "Tp": { + "title": "TaxRecordPeriod1Code", + "description": "Specifies the period related to the tax payment\n\nMM01 FirstMonth Tax is related to the second month of the period.\nMM02 SecondMonth Tax is related to the first month of the period.\nMM03 ThirdMonth Tax is related to the third month of the period.\nMM04 FourthMonth Tax is related to the fourth month of the period.\nMM05 FifthMonth Tax is related to the fifth month of the period.\nMM06 SixthMonth Tax is related to the sixth month of the period.\nMM07 SeventhMonth Tax is related to the seventh month of the period.\nMM08 EighthMonth Tax is related to the eighth month of the period.\nMM09 NinthMonth Tax is related to the ninth month of the period.\nMM10 TenthMonth Tax is related to the tenth month of the period.\nMM11 EleventhMonth Tax is related to the eleventh month of the period.\nMM12 TwelfthMonth Tax is related to the twelfth month of the period.\nQTR1 FirstQuarter Tax is related to the first quarter of the period.\nQTR2 SecondQuarter Tax is related to the second quarter of the period.\nQTR3 ThirdQuarter Tax is related to the third quarter of the period.\nQTR4 FourthQuarter Tax is related to the forth quarter of the period.\nHLF1 FirstHalf Tax is related to the first half of the period.\nHLF2 SecondHalf Tax is related to the second half of the period.\n", + "type": "string", + "enum": [ + "MM01", + "MM02", + "MM03", + "MM04", + "MM05", + "MM06", + "MM07", + "MM08", + "MM09", + "MM10", + "MM11", + "MM12", + "QTR1", + "QTR2", + "QTR3", + "QTR4", + "HLF1", + "HLF2" + ], + "example": "HLF1" + }, + "FrToDt": { + "title": "DatePeriod2", + "description": "Range of time defined by a start date and an end date.\n", + "type": "object", + "properties": { + "FrDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "ToDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + } + }, + "required": [ + "FrDt", + "ToDt" + ], + "example": { + "FrDt": "2020-01-01", + "ToDt": "2020-12-31" + } + } + }, + "example": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + } + }, + "Amt": { + "title": "ActiveOrHistoricCurrencyAndAmount", + "type": "object", + "description": "A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217.\n", + "properties": { + "ActiveOrHistoricCurrencyAndAmount": { + "title": "ActiveOrHistoricCurrencyAndAmount_SimpleType", + "type": "string", + "pattern": "^(?=[\\d\\-\\.\\,]{1,18}$)([\\d\\-\\,\\.]{1,5})?$", + "example": 123.45 + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + } + }, + "required": [ + "ActiveOrHistoricCurrencyAndAmount", + "Ccy" + ], + "example": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + } + } + }, + "required": [ + "Amt" + ], + "example": { + "Prd": { + "Yr": 2020, + "Tp": "MM01", + "FrToDt": { + "FrDt": "2020-01-01", + "ToDt": "2020-01-31" + } + }, + "Amt": { + "Amt": 100, + "Ccy": "EUR" + } + } + } + }, + "example": { + "Rate": 0, + "TaxblBaseAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "TtlAmt": { + "Ccy": "EUR", + "Amt": 0 + }, + "Dtls": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "AddtlInf": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + } + }, + "example": { + "Tp": "VAT", + "Ctgy": "A", + "CtgyDtls": "Standard", + "DbtrSts": "Resident", + "CertId": 123456789, + "FrmsCd": 123456789, + "Prd": { + "FrstDay": "2019-01-01", + "LastDay": "2019-12-31" + }, + "TaxAmt": { + "Rate": 0.2, + "TaxblBaseAmt": 1000, + "TtlAmt": 200 + }, + "AddtlInf": "VAT applicable" + } + } + }, + "example": { + "Cdtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "Dbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "UltmtDbtr": { + "Titl": "Mr", + "Nm": "John Doe" + }, + "AdmstnZone": "CH", + "RefNb": 12345, + "Mtd": "A", + "TtlTaxblBaseAmt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "TtlTaxAmt": { + "Ccy": "CHF", + "Amt": 100 + }, + "Dt": "2018-01-01", + "SeqNb": 1, + "Rcrd": { + "Tp": "T1", + "Ctry": "CH", + "Cd": "CHF", + "Amt": { + "Ccy": "CHF", + "Amt": 1000 + }, + "Inf": 12345 + } + } + }, + "VrfctnOfTerms": { + "title": "CryptographicLockChoice", + "description": "NOTE: Unsure on description.\n", + "type": "object", + "properties": { + "IlpV4PrepPacket": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + }, + "Sh256Sgntr": { + "title": "Exact32HexBinaryText", + "description": "Specifies a hexadecimal string with a length of 32 characters.\n", + "type": "string", + "pattern": "^([0-9A-F][0-9A-F]){32}$", + "example": "1234567890ABCDEF1234567890ABCDEF" + } + }, + "oneOf": [ + { + "required": [ + "IlpV4PrepPacket" + ] + }, + { + "required": [ + "Sh256Sgntr" + ] + } + ], + "example": { + "IlpV4PrepPacket": "1234567890ABCDEF" + } + } + }, + "required": [ + "PmtId", + "IntrBkSttlmAmt", + "ChrgBr", + "Dbtr", + "DbtrAgt", + "CdtrAgt", + "Cdtr" + ], + "example": { + "PmtId": { + "InstrId": "INSTRID", + "EndToEndId": "ENDTOENDID" + }, + "PmtTpInf": { + "LclInstrm": { + "Cd": "CHQB", + "Prtry": "PROPRIETARY" + }, + "SeqTp": "SEQTP" + }, + "IntrBkSttlmAmt": { + "ActiveCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "InstdAmt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "XchgRate": 123.45, + "ChrgBr": "SHAR", + "ChrgsInf": { + "Amt": { + "ActiveOrHistoricCurrencyAndAmount": 123.45, + "Ccy": "USD" + }, + "Agt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Tp": { + "Cd": "SHAR" + } + }, + "Dbtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "DbtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "DbtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "CdtrAgt": { + "BrnchId": { + "Id": "BRANCHID" + }, + "FinInstnId": { + "BICFI": "BICFI" + } + }, + "Cdtr": { + "Nm": "NAME", + "PstlAdr": { + "AdrTp": "ADDR", + "BldgNb": "BLDGNB", + "Ctry": "CTRY", + "TwnNm": "TWNNM", + "PstCd": "PSTCD", + "StrtNm": "STRTNM" + } + }, + "CdtrAcct": { + "Id": { + "IBAN": "IBAN" + } + }, + "InstrForCdtrAgt": { + "Cd": "CODE" + }, + "InstrForNxtAgt": { + "Cd": "CODE" + }, + "Purp": { + "Cd": "CASH" + }, + "RgltryRptg": { + "Dbtr": true, + "Cdtr": true + }, + "Tax": "Cdtr" + } + } + }, + "required": [ + "GrpHdr", + "CdtTrfTxInf" + ], + "example": { + "GrpHdr": { + "MsgId": 123456789, + "CreDtTm": "2020-01-01T00:00:00Z", + "NbOfTxs": 1, + "CtrlSum": 100, + "InitgPty": { + "Nm": "Initiating Party Name", + "Id": { + "OrgId": { + "Othr": [ + { + "Id": 123456789, + "SchmeNm": { + "Cd": "BBA", + "Prtry": "Party Identification Scheme Name" + } + } + ] + } + } + }, + "FwdgAgt": { + "FinInstnId": { + "BICFI": "BBBBBBBB" + } + } + } + } + }, + "UUIDv4Identifier": { + "title": "UUIDv4Identifier", + "type": "string", + "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$", + "example": "8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e" + }, + "VerificationReason1Choice": { + "title": "VerificationReason1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalVerificationReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "VerificationReport4": { + "title": "VerificationReport4", + "type": "object", + "properties": { + "OrgnlId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Vrfctn": { + "title": "IdentificationVerificationIndicator", + "type": "boolean", + "example": true + }, + "Rsn": { + "title": "VerificationReason1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalVerificationReason1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "AGNT" + } + }, + "OrgnlPtyAndAcctId": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + }, + "UpdtdPtyAndAcctId": { + "title": "IdentificationInformation4", + "type": "object", + "properties": { + "Pty": { + "title": "PartyIdentification135", + "description": "Specifies the identification of a person or an organisation.\n", + "type": "object", + "properties": { + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Id": { + "title": "Party38Choice", + "description": "Nature or use of the account.\n", + "type": "object", + "properties": { + "OrgId": { + "title": "OrganisationIdentification29", + "description": "Unique and unambiguous way to identify an organisation.\n", + "type": "object", + "properties": { + "AnyBIC": { + "title": "AnyBICDec2014Identifier", + "type": "string", + "description": "AnyBICDec2014Identifier\nCode allocated to a financial or non-financial institution by the\nISO 9362 Registration Authority, as described in ISO 9362: 2014\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Othr": { + "title": "GenericOrganisationIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "OrganisationIdentificationSchemeName1Choice", + "description": "Choice of format for the organisation identification.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalOrganisationIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "AnyBIC": "BICFI", + "LEI": "529900T8BM49AURSDO55", + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "BIC" + }, + "Issr": "BIC" + } + } + }, + "PrvtId": { + "title": "PersonIdentification13", + "description": "Unique and unambiguous way to identify a person.\n", + "type": "object", + "properties": { + "DtAndPlcOfBirth": { + "title": "DateAndPlaceOfBirth1", + "description": "Details about date and place of birth of a person.\n", + "type": "object", + "properties": { + "BirthDt": { + "title": "ISODate", + "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\n", + "type": "string", + "format": "date", + "example": "2013-03-07" + }, + "PrvcOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CityOfBirth": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtryOfBirth": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + } + }, + "required": [ + "BirthDt", + "CityOfBirth", + "CtryOfBirth" + ], + "example": { + "BirthDt": "1970-01-01", + "PrvcOfBirth": "ON", + "CityOfBirth": "Ottawa", + "CtryOfBirth": "CA" + } + }, + "Othr": { + "title": "GenericPersonIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "PersonIdentificationSchemeName1Choice", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalPersonIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CCPT" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "DRLC" + }, + "Issr": "BIC" + } + } + }, + "example": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + }, + "Othr": { + "Id": 123, + "SchmeNm": { + "Cd": "CUST", + "Prtry": 1 + } + } + } + } + }, + "oneOf": [ + { + "required": [ + "OrgId" + ] + }, + { + "required": [ + "PrvtId" + ] + } + ], + "example": { + "OrgId": { + "AnyBIC": "BIC" + }, + "PrvtId": { + "DtAndPlcOfBirth": { + "Dt": "2018-01-01", + "CityOfBirth": "City" + } + } + } + }, + "CtryOfRes": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "CtctDtls": { + "title": "Contact4", + "description": "Specifies the details of the contact person.\n", + "type": "object", + "properties": { + "NmPrfx": { + "description": "Specifies the terms used to formally address a person.\n", + "enum": [ + "DOCT", + "MADM", + "MISS", + "MIST", + "MIKS" + ], + "type": "string", + "example": "DOCT" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PhneNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "MobNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "FaxNb": { + "title": "PhoneNumber", + "type": "string", + "description": "Double check this regex.\n", + "pattern": "^\\+[0-9]{1,3}-[0-9()+\\-]{1,30}$" + }, + "EmailAdr": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + }, + "EmailPurp": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "JobTitl": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Rspnsblty": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Othr": { + "title": "OtherContact1", + "description": "Communication device number or electronic address used for communication.\n", + "type": "object", + "properties": { + "ChanlTp": { + "title": "Max4Text", + "description": "Specifies a character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Id": { + "title": "Max128Text", + "description": "Specifies a character string with a maximum length of 128 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 128, + "example": 12345 + } + }, + "required": [ + "ChanlTp" + ], + "example": { + "ChanlTp": "PHON", + "Id": 1234567890 + } + }, + "PrefrdMtd": { + "title": "PreferredContactMethod1Code", + "description": "Preferred method used to reach the individual contact within an organisation.\n", + "type": "string", + "enum": [ + "LETT", + "MAIL", + "PHON", + "FAXX", + "CELL" + ], + "example": "CELL" + } + }, + "example": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": "example@example.com" + } + } + }, + "example": { + "Nm": "John Doe", + "PstlAdr": { + "Ctry": "BE", + "AdrLine": [ + "Rue du Marché 45", + "Brussels", + "BE" + ] + }, + "Id": { + "OrgId": { + "AnyBIC": "CCCCUS33" + } + }, + "CtryOfRes": "BE", + "CtctDtls": { + "NmPrfx": "Mr", + "Nm": "John Doe", + "PhneNb": "+123-123-321", + "MobNb": "+123-123-321", + "FaxNb": "+123-123-321", + "EmailAdr": null + } + } + }, + "Acct": { + "title": "CashAccount40", + "type": "object", + "description": "Provides the details to identify an account.\n", + "properties": { + "Id": { + "title": "AccountIdentification4Choice", + "type": "object", + "description": "Specifies the unique identification of an account as assigned by the account servicer.\n", + "properties": { + "IBAN": { + "title": "IBAN2007Identifier", + "description": "The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard \"Banking and related financial services -\nInternational Bank Account Number (IBAN)\" and replaced by the more recent edition of the standard.\n", + "type": "string", + "pattern": "^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$", + "example": "FR1420041010050500013M02606" + }, + "Othr": { + "title": "GenericAccountIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max34Text", + "description": "Specifies a character string with a maximum length of 34 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 34, + "example": 1.2345678901234568e+33 + }, + "SchmeNm": { + "title": "AccountSchemeName1Choice", + "type": "object", + "description": "Sets of elements to identify a name of the identification scheme.\n", + "properties": { + "Cd": { + "title": "ExternalAccountIdentification1Code", + "description": "Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": 1111 + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "oneOf": [ + { + "required": [ + "IBAN" + ] + }, + { + "required": [ + "Othr" + ] + } + ], + "example": { + "IBAN": "BE71096123456769" + } + }, + "Tp": { + "title": "CashAccountType2Choice", + "description": "Specifies the nature, or use of the account.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalCashAccountType1Code", + "description": "Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CACC" + } + }, + "Ccy": { + "title": "ActiveOrHistoricCurrencyCode", + "type": "string", + "description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".\n", + "pattern": "^[A-Z]{3,3}$", + "example": "USD" + }, + "Nm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "Prxy": { + "title": "ProxyAccountIdentification1", + "description": "Information related to a proxy identification of the account.\n", + "type": "object", + "properties": { + "Tp": { + "title": "ProxyAccountType1Choice", + "type": "object", + "description": "NOTE: Unsure on description.\n", + "properties": { + "Cd": { + "title": "ExternalProxyAccountType1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CH03" + } + }, + "Id": { + "title": "Max2048Text", + "description": "Specifies a character string with a maximum length of 2048 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 2048, + "example": 2048 + } + }, + "required": [ + "Id" + ], + "example": { + "Tp": { + "Cd": "IBAN" + }, + "Id": 123 + } + } + }, + "example": { + "Id": { + "IBAN": "BE71096123456769" + }, + "Tp": { + "Cd": "CACC" + }, + "Ccy": "EUR", + "Nm": "My account", + "Prxy": { + "Id": 12345 + } + } + }, + "Agt": { + "title": "BranchAndFinancialInstitutionIdentification6", + "type": "object", + "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.\n", + "properties": { + "FinInstnId": { + "title": "FinancialInstitutionIdentification18", + "type": "object", + "properties": { + "BICFI": { + "title": "BICFIDec2014Identifier", + "type": "string", + "description": "Code allocated to a financial institution by the ISO 9362 Registration\n\nAuthority as described in ISO 9362: 2014\n\n- \"Banking - Banking telecommunication messages - Business identifier code (BIC)\".\n", + "pattern": "^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$", + "example": "J5BMVH7D" + }, + "ClrSysMmbId": { + "title": "ClearingSystemMemberIdentification2", + "description": "Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system.\n", + "type": "object", + "properties": { + "ClrSysId": { + "title": "ClearingSystemIdentification2Choice", + "description": "Choice of a clearing system identifier.\n", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalClearingSystemIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 5, + "example": 12345 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "CHQB" + } + }, + "MmbId": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "MmbId" + ], + "example": { + "ClrSysId": { + "Cd": "CHQB" + }, + "MmbId": 123456789 + } + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + }, + "Othr": { + "title": "GenericFinancialIdentification1", + "type": "object", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "FinancialIdentificationSchemeName1Choice", + "type": "object", + "properties": { + "Cd": { + "title": "ExternalFinancialInstitutionIdentification1Code", + "type": "string", + "minLength": 1, + "maxLength": 4, + "example": 1234 + }, + "Prtry": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "BIC" + } + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id" + ], + "example": { + "Id": 123, + "SchmeNm": { + "Cd": "IBAN" + }, + "Issr": "BIC" + } + } + }, + "example": { + "BICFI": "BUKBGB22", + "Nm": "Barclays Bank Plc", + "PstlAdr": { + "Ctry": "GB", + "AdrLine": [ + "1 Churchill Place", + "London", + "UK" + ] + } + } + }, + "BrnchId": { + "title": "BranchData3", + "type": "object", + "description": "Information that locates and identifies a specific branch of a financial institution.\n", + "properties": { + "Id": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "LEI": { + "title": "LEIIdentifier", + "description": "Legal Entity Identifier is a code allocated to a party as described in ISO 17442 \"Financial Services - Legal Entity Identifier (LEI)\". ^([0-9A-Z]{18,18}[0-9]{2,2})$\n", + "type": "string", + "pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$", + "example": "529900T8BM49AURSDO55" + }, + "Nm": { + "title": "Max140Text", + "description": "Specifies a character string with a maximum length of 140 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 140, + "example": 12345 + }, + "PstlAdr": { + "title": "PostalAddress24", + "type": "object", + "description": "Information that locates and identifies a specific address, as defined by postal services.\n", + "properties": { + "AdrTp": { + "title": "AddressType3Choice", + "type": "object", + "description": "Choice of formats for the type of address.\n", + "properties": { + "Cd": { + "description": "AddressType2Code\nSpecifies the type of address.\n", + "enum": [ + "ADDR", + "PBOX", + "HOME", + "BIZZ", + "MLTO", + "DLVY" + ], + "type": "string", + "example": "ADDR" + }, + "Prtry": { + "title": "GenericIdentification30", + "type": "object", + "properties": { + "Id": { + "title": "Exact4AlphaNumericText", + "description": "Specifies an alphanumeric string with a length of 4 characters.\n", + "type": "string", + "pattern": "^[a-zA-Z0-9]{4}$", + "example": 1234 + }, + "Issr": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "SchmeNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + } + }, + "required": [ + "Id", + "Issr" + ], + "example": { + "Id": 1234, + "Issr": "BIC", + "SchmeNm": "BICFI" + } + } + }, + "oneOf": [ + { + "required": [ + "Cd" + ] + }, + { + "required": [ + "Prtry" + ] + } + ], + "example": { + "Cd": "ADDR" + } + }, + "Dept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "SubDept": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "StrtNm": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "BldgNb": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "BldgNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Flr": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstBx": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "Room": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + }, + "PstCd": { + "title": "Max16Text", + "description": "Specifies a character string with a maximum length of 16 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 16, + "example": 1234567890123456 + }, + "TwnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "TwnLctnNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "DstrctNm": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "CtrySubDvsn": { + "title": "Max35Text", + "description": "Specifies a character string with a maximum length of 35 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 35, + "example": 1.234567890123457e+34 + }, + "Ctry": { + "title": "CountryCode", + "type": "string", + "pattern": "^[A-Z]{2,2}$", + "example": "US" + }, + "AdrLine": { + "title": "Max70Text", + "description": "Specifies a character string with a maximum length of 70 characters.\n", + "type": "string", + "minLength": 1, + "maxLength": 70, + "example": 1.2345678901234567e+99 + } + }, + "example": { + "AdrTp": "ADDR", + "Dept": "Dept", + "SubDept": "SubDept", + "StrtNm": "StrtNm", + "BldgNb": "BldgNb", + "BldgNm": "BldgNm", + "Flr": "Flr", + "PstBx": "PstBx", + "Room": "Room", + "PstCd": "PstCd", + "TwnNm": "TwnNm", + "TwnLctnNm": "TwnLctnNm", + "DstrctNm": "DstrctNm", + "CtrySubDvsn": "CtrySubDvsn", + "Ctry": "Ctry", + "AdrLine": "AdrLine" + } + } + }, + "example": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + }, + "required": [ + "FinInstnId" + ], + "example": { + "FinInstnId": { + "BICFI": "J5BMVH7D" + }, + "BrnchId": { + "Id": 123, + "Nm": "Name", + "PstlAdr": { + "AdrTp": "ADDR", + "Dept": "Department", + "SubDept": "Sub department", + "StrtNm": "Street name", + "BldgNb": "Building number", + "PstCd": "Post code", + "TwnNm": "Town name", + "CtrySubDvsn": "Country subdivision", + "Ctry": "Country", + "AdrLine": "Address line" + } + } + } + } + }, + "example": { + "Pty": { + "Id": { + "OrgId": { + "AnyBIC": { + "BICFI": "BICFI" + } + } + }, + "CtryOfRes": "FI" + }, + "Acct": { + "Id": { + "IBAN": "FI2112345600000785" + } + }, + "Agt": { + "FinInstnId": { + "BICFI": "BICFI" + } + } + } + } + }, + "required": [ + "OrgnlId", + "Vrfctn" + ], + "example": { + "OrgnlId": 123456789, + "Vrfctn": true, + "Rsn": { + "Cd": "AGNT" + }, + "OrgnlPtyAndAcctId": { + "Id": 123456789, + "SchmeNm": { + "Cd": "CCPT" + } + }, + "UpdtdPtyAndAcctId": { + "Id": 123456789, + "SchmeNm": { + "Cd": "CCPT" + } + } + } + }, + "hexBinary": { + "title": "hexBinary", + "type": "string", + "pattern": "^(0x|0X)?[a-fA-F0-9]+$", + "example": 4660 + } +} \ No newline at end of file diff --git a/src/fspiop/v2_0_ISO20022/openapi.ts b/src/fspiop/v2_0_ISO20022/openapi.ts new file mode 100644 index 00000000..58b37be9 --- /dev/null +++ b/src/fspiop/v2_0_ISO20022/openapi.ts @@ -0,0 +1,5163 @@ +/** + * This file was auto-generated by openapi-typescript. + * Do not make direct changes to the file. + */ + +export interface paths { + "/parties/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesByTypeAndID2"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used. + */ + put: operations["PartiesErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * Look up party information + * @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`). + */ + get: operations["PartiesSubIdByTypeAndID"]; + /** + * Return party information + * @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup. + */ + put: operations["PartiesSubIdByTypeAndIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return party information error + * @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["PartiesSubIdErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate quote + * @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server. + */ + post: operations["Quotes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve quote information + * @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote. + */ + get: operations["QuotesByID"]; + /** + * Return quote information + * @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByID1"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return quote information error + * @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request. + */ + put: operations["QuotesByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform transfer + * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP. + */ + post: operations["transfers"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve transfer information + * @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer. + */ + get: operations["TransfersByIDGet"]; + /** + * Return transfer information + * @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request. + */ + put: operations["TransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Return transfer information + * @description The HTTP request PATCH /transfers/ is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback. + */ + patch: operations["TransfersByIDPatch"]; + trace?: never; + }; + "/transfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return transfer information error + * @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`. + */ + put: operations["TransfersByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate FX quote + * @description The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion. + */ + post: operations["FxQuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve FX quote information + * @description The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote. + */ + get: operations["FxQuotesByIDGet"]; + /** + * Return FX quote information + * @description The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. + */ + put: operations["FxQuotesByIdPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return FX quote information error + * @description If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request. + */ + put: operations["FxQuotesByIDAndErrorPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform FX transfer + * @description The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion. + */ + post: operations["FxTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Retrieve FX transfer information + * @description The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer. + */ + get: operations["FxTransfersByIDGet"]; + /** + * Return FX transfer information + * @description The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request. + */ + put: operations["FxTransfersByIDPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Return FX transfer information + * @description The HTTP request PATCH /fxTransfers/ is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback. + */ + patch: operations["FxTransfersByIDPatch"]; + trace?: never; + }; + "/fxTransfers/{ID}/error": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Return FX transfer information error + * @description If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`. + */ + put: operations["FxTransfersByIDAndErrorPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + /** + * AccountIdentification4Choice + * @description Specifies the unique identification of an account as assigned by the account servicer. + * + * @example { + * "IBAN": "BE71096123456769" + * } + */ + AccountIdentification4Choice: { + IBAN?: components["schemas"]["IBAN2007Identifier"]; + Othr?: components["schemas"]["GenericAccountIdentification1"]; + } & (unknown | unknown); + /** + * AccountSchemeName1Choice + * @description Sets of elements to identify a name of the identification scheme. + * + * @example { + * "Cd": 1111 + * } + */ + AccountSchemeName1Choice: { + Cd?: components["schemas"]["ExternalAccountIdentification1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * ActiveCurrencyAndAmount + * @description A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. + * + * @example { + * "ActiveCurrencyAndAmount": 123.45, + * "Ccy": "USD" + * } + */ + ActiveCurrencyAndAmount: { + ActiveCurrencyAndAmount: components["schemas"]["ActiveCurrencyAndAmount_SimpleType"]; + Ccy: components["schemas"]["ActiveCurrencyCode"]; + }; + /** + * ActiveCurrencyAndAmount_SimpleType + * @description NOTE: This regex doesn't seem correct given it's xsd definition. + * + * + * + * + * + * + * + * + * @example 123.45 + */ + ActiveCurrencyAndAmount_SimpleType: string; + /** + * ActiveCurrencyCode + * @description A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". + * @example USD + */ + ActiveCurrencyCode: string; + /** + * ActiveOrHistoricCurrencyAndAmount + * @description A number of monetary units specified in an active or a historic currency where the unit of currency is explicit and compliant with ISO 4217. + * + * @example { + * "ActiveOrHistoricCurrencyAndAmount": 123.45, + * "Ccy": "USD" + * } + */ + ActiveOrHistoricCurrencyAndAmount: { + ActiveOrHistoricCurrencyAndAmount: components["schemas"]["ActiveOrHistoricCurrencyAndAmount_SimpleType"]; + Ccy: components["schemas"]["ActiveOrHistoricCurrencyCode"]; + }; + /** + * ActiveOrHistoricCurrencyAndAmount_SimpleType + * @example 123.45 + */ + ActiveOrHistoricCurrencyAndAmount_SimpleType: string; + /** + * ActiveOrHistoricCurrencyCode + * @description A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". + * + * @example USD + */ + ActiveOrHistoricCurrencyCode: string; + /** + * @description AddressType2Code + * Specifies the type of address. + * + * @example ADDR + * @enum {string} + */ + AddressType2Code: "ADDR" | "PBOX" | "HOME" | "BIZZ" | "MLTO" | "DLVY"; + /** + * AddressType3Choice + * @description Choice of formats for the type of address. + * + * @example { + * "Cd": "ADDR" + * } + */ + AddressType3Choice: { + Cd?: components["schemas"]["AddressType2Code"]; + Prtry?: components["schemas"]["GenericIdentification30"]; + } & (unknown | unknown); + /** + * AnyBICDec2014Identifier + * @description AnyBICDec2014Identifier + * Code allocated to a financial or non-financial institution by the + * ISO 9362 Registration Authority, as described in ISO 9362: 2014 + * - "Banking - Banking telecommunication messages - Business identifier code (BIC)". + * + * @example J5BMVH7D + */ + AnyBICDec2014Identifier: string; + /** + * BICFIDec2014Identifier + * @description Code allocated to a financial institution by the ISO 9362 Registration + * + * Authority as described in ISO 9362: 2014 + * + * - "Banking - Banking telecommunication messages - Business identifier code (BIC)". + * + * @example J5BMVH7D + */ + BICFIDec2014Identifier: string; + /** + * BaseOneRate + * @description Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%. + * + * @example 0.7 + */ + BaseOneRate: string; + /** + * BranchAndFinancialInstitutionIdentification6 + * @description Unique and unambiguous identification of a financial institution or a branch of a financial institution. + * + * @example { + * "FinInstnId": { + * "BICFI": "J5BMVH7D" + * }, + * "BrnchId": { + * "Id": 123, + * "Nm": "Name", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "Dept": "Department", + * "SubDept": "Sub department", + * "StrtNm": "Street name", + * "BldgNb": "Building number", + * "PstCd": "Post code", + * "TwnNm": "Town name", + * "CtrySubDvsn": "Country subdivision", + * "Ctry": "Country", + * "AdrLine": "Address line" + * } + * } + * } + */ + BranchAndFinancialInstitutionIdentification6: { + FinInstnId: components["schemas"]["FinancialInstitutionIdentification18"]; + BrnchId?: components["schemas"]["BranchData3"]; + }; + /** + * BranchAndFinancialInstitutionIdentification8 + * @description Unique and unambiguous identification of a financial institution or a branch of a financial institution. + * + * @example { + * "FinInstnId": { + * "BICFI": "BUKBGB22" + * }, + * "BrnchId": { + * "Id": 12345, + * "Nm": "Oxford Street Branch", + * "PstlAdr": { + * "Ctry": "GB", + * "AdrLine": [ + * "1 Oxford Street", + * "London", + * "UK" + * ] + * } + * } + * } + */ + BranchAndFinancialInstitutionIdentification8: { + FinInstnId: components["schemas"]["FinancialInstitutionIdentification23"]; + BrnchId?: components["schemas"]["BranchData5"]; + }; + /** + * BranchData3 + * @description Information that locates and identifies a specific branch of a financial institution. + * + * @example { + * "Id": 123, + * "Nm": "Name", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "Dept": "Department", + * "SubDept": "Sub department", + * "StrtNm": "Street name", + * "BldgNb": "Building number", + * "PstCd": "Post code", + * "TwnNm": "Town name", + * "CtrySubDvsn": "Country subdivision", + * "Ctry": "Country", + * "AdrLine": "Address line" + * } + * } + */ + BranchData3: { + Id?: components["schemas"]["Max35Text"]; + LEI?: components["schemas"]["LEIIdentifier"]; + Nm?: components["schemas"]["Max140Text"]; + PstlAdr?: components["schemas"]["PostalAddress24"]; + }; + /** + * BranchData5 + * @description Information that locates and identifies a specific branch of a financial institution. + * + * @example { + * "Id": 123, + * "Nm": "Oxford Street Branch", + * "PstlAdr": { + * "Ctry": "GB", + * "AdrLine": [ + * "1 Oxford Street", + * "London", + * "UK" + * ] + * } + * } + */ + BranchData5: { + Id?: components["schemas"]["Max35Text"]; + LEI?: components["schemas"]["LEIIdentifier"]; + Nm?: components["schemas"]["Max140Text"]; + PstlAdr?: components["schemas"]["PostalAddress27"]; + }; + /** + * CashAccount40 + * @description Provides the details to identify an account. + * + * @example { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Tp": { + * "Cd": "CACC" + * }, + * "Ccy": "EUR", + * "Nm": "My account", + * "Prxy": { + * "Id": 12345 + * } + * } + */ + CashAccount40: { + Id?: components["schemas"]["AccountIdentification4Choice"]; + Tp?: components["schemas"]["CashAccountType2Choice"]; + Ccy?: components["schemas"]["ActiveOrHistoricCurrencyCode"]; + Nm?: components["schemas"]["Max70Text"]; + Prxy?: components["schemas"]["ProxyAccountIdentification1"]; + }; + /** + * CashAccountType2Choice + * @description Specifies the nature, or use of the account. + * + * @example { + * "Cd": "CACC" + * } + */ + CashAccountType2Choice: { + Cd?: components["schemas"]["ExternalCashAccountType1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * CategoryPurpose1Choice + * @description Contains details about high level purpose of the mandate based on a set of pre-defined categories. + * + * @example { + * "Cd": "CASH" + * } + */ + CategoryPurpose1Choice: { + Cd?: components["schemas"]["ExternalCategoryPurpose1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * ChargeBearerType1Code + * @description Specifies which party(ies) will pay charges due for processing of the instruction. + * DEBT BorneByDebtor All transaction charges are to be borne by the debtor. + * CRED BorneByCreditor All transaction charges are to be borne by the creditor. + * SHAR Shared In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver + * SLEV FollowingServiceLevel Charges are to be applied following the rules agreed in the service level. + * + * @example DEBT + * @enum {string} + */ + ChargeBearerType1Code: "DEBT" | "CRED" | "SHAR" | "SLEV"; + /** + * ChargeType3Choice + * @description ChargeType3Choice Specifies the type of charge. + * @example { + * "Cd": "CASH" + * } + */ + ChargeType3Choice: { + Cd?: components["schemas"]["ExternalChargeType1Code"]; + Prtry?: components["schemas"]["GenericIdentification3"]; + } & (unknown | unknown); + /** + * Charges16 + * @description NOTE: Unsure on description. + * + * @example { + * "Amt": { + * "ActiveOrHistoricCurrencyAndAmount": 123.45, + * "Ccy": "USD" + * }, + * "Agt": { + * "BrnchId": { + * "Id": "BRANCHID" + * }, + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "Tp": { + * "Cd": "SHAR" + * } + * } + */ + Charges16: { + Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + Agt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + Tp?: components["schemas"]["ChargeType3Choice"]; + }; + /** + * ClearingChannel2Code + * @description Specifies the clearing channel for the routing of the transaction, as part of the payment type identification. + * RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross settlement system. + * RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net settlement system. + * MPNS MassPaymentNetSystem Clearing channel is a mass payment net settlement system. + * BOOK BookTransfer Payment through internal book transfer. + * + * @example RTGS + * @enum {string} + */ + ClearingChannel2Code: "RTGS" | "RTNS" | "MPNS" | "BOOK"; + /** + * ClearingSystemIdentification2Choice + * @description Choice of a clearing system identifier. + * + * @example { + * "Cd": "CHQB" + * } + */ + ClearingSystemIdentification2Choice: { + Cd?: components["schemas"]["ExternalClearingSystemIdentification1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * ClearingSystemMemberIdentification2 + * @description Unique identification, as assigned by a clearing system, to unambiguously identify a member of the clearing system. + * + * @example { + * "ClrSysId": { + * "Cd": "CHQB" + * }, + * "MmbId": 123456789 + * } + */ + ClearingSystemMemberIdentification2: { + ClrSysId?: components["schemas"]["ClearingSystemIdentification2Choice"]; + MmbId: components["schemas"]["Max35Text"]; + }; + /** + * Contact13 + * @description Specifies the details of the contact person. + * + * @example { + * "NmPrfx": "Mr", + * "Nm": "John Doe", + * "PhneNb": "+123-123-321", + * "MobNb": "+123-123-321", + * "FaxNb": "+123-123-321", + * "URLAdr": "http://www.example.com", + * "EmailAdr": "example@example.com" + * } + */ + Contact13: { + NmPrfx?: components["schemas"]["NamePrefix2Code"]; + Nm?: components["schemas"]["Max140Text"]; + PhneNb?: components["schemas"]["PhoneNumber"]; + MobNb?: components["schemas"]["PhoneNumber"]; + FaxNb?: components["schemas"]["PhoneNumber"]; + URLAdr?: components["schemas"]["Max2048Text"]; + EmailAdr?: components["schemas"]["Max256Text"]; + EmailPurp?: components["schemas"]["Max35Text"]; + JobTitl?: components["schemas"]["Max35Text"]; + Rspnsblty?: components["schemas"]["Max35Text"]; + Dept?: components["schemas"]["Max70Text"]; + Othr?: components["schemas"]["OtherContact1"]; + PrefrdMtd?: components["schemas"]["PreferredContactMethod2Code"]; + }; + /** + * Contact4 + * @description Specifies the details of the contact person. + * + * @example { + * "NmPrfx": "Mr", + * "Nm": "John Doe", + * "PhneNb": "+123-123-321", + * "MobNb": "+123-123-321", + * "FaxNb": "+123-123-321", + * "EmailAdr": "example@example.com" + * } + */ + Contact4: { + NmPrfx?: components["schemas"]["NamePrefix2Code"]; + Nm?: components["schemas"]["Max140Text"]; + PhneNb?: components["schemas"]["PhoneNumber"]; + MobNb?: components["schemas"]["PhoneNumber"]; + FaxNb?: components["schemas"]["PhoneNumber"]; + EmailAdr?: components["schemas"]["Max2048Text"]; + EmailPurp?: components["schemas"]["Max35Text"]; + JobTitl?: components["schemas"]["Max35Text"]; + Rspnsblty?: components["schemas"]["Max35Text"]; + Dept?: components["schemas"]["Max70Text"]; + Othr?: components["schemas"]["OtherContact1"]; + PrefrdMtd?: components["schemas"]["PreferredContactMethod1Code"]; + }; + /** + * CountryCode + * @example US + */ + CountryCode: string; + /** + * CreditTransferTransaction67 + * @description Provides further details specific to the individual transaction(s) included in the message. + * + * @example { + * "PmtId": { + * "InstrId": "INSTRID", + * "EndToEndId": "ENDTOENDID" + * }, + * "PmtTpInf": { + * "LclInstrm": { + * "Cd": "CHQB", + * "Prtry": "PROPRIETARY" + * }, + * "SeqTp": "SEQTP" + * }, + * "IntrBkSttlmAmt": { + * "ActiveCurrencyAndAmount": 123.45, + * "Ccy": "USD" + * }, + * "InstdAmt": { + * "ActiveOrHistoricCurrencyAndAmount": 123.45, + * "Ccy": "USD" + * }, + * "XchgRate": 123.45, + * "ChrgBr": "SHAR", + * "ChrgsInf": { + * "Amt": { + * "ActiveOrHistoricCurrencyAndAmount": 123.45, + * "Ccy": "USD" + * }, + * "Agt": { + * "BrnchId": { + * "Id": "BRANCHID" + * }, + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "Tp": { + * "Cd": "SHAR" + * } + * }, + * "Dbtr": { + * "Nm": "NAME", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "BldgNb": "BLDGNB", + * "Ctry": "CTRY", + * "TwnNm": "TWNNM", + * "PstCd": "PSTCD", + * "StrtNm": "STRTNM" + * } + * }, + * "DbtrAcct": { + * "Id": { + * "IBAN": "IBAN" + * } + * }, + * "DbtrAgt": { + * "BrnchId": { + * "Id": "BRANCHID" + * }, + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "CdtrAgt": { + * "BrnchId": { + * "Id": "BRANCHID" + * }, + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "Cdtr": { + * "Nm": "NAME", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "BldgNb": "BLDGNB", + * "Ctry": "CTRY", + * "TwnNm": "TWNNM", + * "PstCd": "PSTCD", + * "StrtNm": "STRTNM" + * } + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "IBAN" + * } + * }, + * "InstrForCdtrAgt": { + * "Cd": "CODE" + * }, + * "InstrForNxtAgt": { + * "Cd": "CODE" + * }, + * "Purp": { + * "Cd": "CASH" + * }, + * "RgltryRptg": { + * "Dbtr": true, + * "Cdtr": true + * }, + * "Tax": "Cdtr" + * } + */ + CreditTransferTransaction67: { + PmtId: components["schemas"]["PaymentIdentification13"]; + PmtTpInf?: components["schemas"]["PaymentTypeInformation28"]; + IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"]; + InstdAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + XchgRate?: components["schemas"]["BaseOneRate"]; + ChrgBr: components["schemas"]["ChargeBearerType1Code"]; + ChrgsInf?: components["schemas"]["Charges16"]; + Dbtr: components["schemas"]["PartyIdentification272"]; + DbtrAcct?: components["schemas"]["CashAccount40"]; + DbtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + CdtrAgt: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + Cdtr: components["schemas"]["PartyIdentification272"]; + CdtrAcct?: components["schemas"]["CashAccount40"]; + InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"]; + InstrForNxtAgt?: components["schemas"]["InstructionForNextAgent1"]; + Purp?: components["schemas"]["Purpose2Choice"]; + RgltryRptg?: components["schemas"]["RegulatoryReporting3"]; + Tax?: components["schemas"]["TaxData1"]; + VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"]; + }; + /** + * CreditTransferTransaction68 + * @description Provides further details specific to the individual transaction(s) included in the message. + * + * @example { + * "PmtId": { + * "InstrId": "INSTRID", + * "EndToEndId": "ENDTOENDID" + * }, + * "PmtTpInf": { + * "LclInstrm": { + * "Cd": "CHQB", + * "Prtry": "PROPRIETARY" + * } + * }, + * "IntrBkSttlmAmt": { + * "Amount": 123.45, + * "Ccy": "EUR" + * }, + * "Dbtr": { + * "Nm": "Debtor Name" + * }, + * "DbtrAcct": { + * "Id": { + * "IBAN": "IBAN" + * } + * }, + * "DbtrAgt": { + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "Cdtr": { + * "Nm": "Creditor Name" + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "IBAN" + * } + * }, + * "InstrForCdtrAgt": { + * "Cd": "INSTRUCTION" + * }, + * "Purp": { + * "Cd": "CHAR" + * }, + * "VrfctnOfTerms": { + * "Cntt": "CONTENT", + * "CnttTp": "PROPRIETARY" + * } + * } + */ + CreditTransferTransaction68: { + PmtId: components["schemas"]["PaymentIdentification13"]; + PmtTpInf?: components["schemas"]["PaymentTypeInformation28"]; + IntrBkSttlmAmt: components["schemas"]["ActiveCurrencyAndAmount"]; + Dbtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + DbtrAcct?: components["schemas"]["CashAccount40"]; + DbtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + CdtrAgt?: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + Cdtr: components["schemas"]["BranchAndFinancialInstitutionIdentification8"]; + CdtrAcct?: components["schemas"]["CashAccount40"]; + InstrForCdtrAgt?: components["schemas"]["InstructionForCreditorAgent3"]; + Purp?: components["schemas"]["Purpose2Choice"]; + VrfctnOfTerms?: components["schemas"]["CryptographicLockChoice"]; + }; + /** + * CryptographicLockChoice + * @description NOTE: Unsure on description. + * + * @example { + * "IlpV4PrepPacket": "1234567890ABCDEF" + * } + */ + CryptographicLockChoice: { + IlpV4PrepPacket?: components["schemas"]["hexBinary"]; + Sh256Sgntr?: components["schemas"]["Exact32HexBinaryText"]; + } & (unknown | unknown); + /** + * DateAndPlaceOfBirth1 + * @description Details about date and place of birth of a person. + * + * @example { + * "BirthDt": "1970-01-01", + * "PrvcOfBirth": "ON", + * "CityOfBirth": "Ottawa", + * "CtryOfBirth": "CA" + * } + */ + DateAndPlaceOfBirth1: { + BirthDt: components["schemas"]["ISODate"]; + PrvcOfBirth?: components["schemas"]["Max35Text"]; + CityOfBirth: components["schemas"]["Max35Text"]; + CtryOfBirth: components["schemas"]["CountryCode"]; + }; + /** + * DatePeriod2 + * @description Range of time defined by a start date and an end date. + * + * @example { + * "FrDt": "2020-01-01", + * "ToDt": "2020-12-31" + * } + */ + DatePeriod2: { + FrDt: components["schemas"]["ISODate"]; + ToDt: components["schemas"]["ISODate"]; + }; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorInformationResponse + * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. + * + */ + ErrorInformationResponse: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * Exact32HexBinaryText + * @description Specifies a hexadecimal string with a length of 32 characters. + * + * @example 1234567890ABCDEF1234567890ABCDEF + */ + Exact32HexBinaryText: string; + /** + * Exact4AlphaNumericText + * @description Specifies an alphanumeric string with a length of 4 characters. + * + * @example 1234 + */ + Exact4AlphaNumericText: string; + /** + * Execute_FIToFICustomerCreditTransferV13 + * @example { + * "GrpHdr": { + * "MsgId": 123456789, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "CtrlSum": 100, + * "InitgPty": { + * "Nm": "Initiating Party Name", + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": 91 + * } + * } + * ] + * } + * } + * }, + * "FwdgAgt": { + * "FinInstnId": { + * "BICFI": "BBBBBBBB" + * } + * } + * }, + * "CdtTrfTxInf": { + * "PmtId": { + * "InstrId": 123456789, + * "EndToEndId": 123456789 + * }, + * "PmtTpInf": { + * "InstrPrty": "NORM", + * "CtgyPurp": { + * "Cd": "SUPP" + * } + * }, + * "InstrForCdtrAgt": { + * "FinInstnId": { + * "BICFI": "AAAAAAAA" + * } + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "AAAAAAAA" + * } + * }, + * "Cdtr": { + * "Nm": "Creditor Name", + * "PstlAdr": { + * "AdrLine": [ + * "Creditor Address Line 1", + * "Creditor Address Line 2", + * "Creditor Address Line 3", + * "Creditor Address Line 4", + * "Creditor Address Line 5" + * ] + * }, + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": 91 + * } + * } + * ] + * } + * } + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "DE87123456781234567890" + * } + * }, + * "RmtInf": { + * "Ustrd": "Remittance Information" + * } + * } + * } + */ + Execute_FIToFICustomerCreditTransferV13: { + GrpHdr: components["schemas"]["GroupHeader129"]; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"]; + }; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + * + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * ExternalAccountIdentification1Code + * @description Specifies the external account identification scheme name code in the format of character string with a maximum length of 4 characters. + * + * @example 1234 + */ + ExternalAccountIdentification1Code: string; + /** + * ExternalCashAccountType1Code + * @description Specifies the nature, or use, of the cash account in the format of character string with a maximum length of 4 characters. + * + * @example 1234 + */ + ExternalCashAccountType1Code: string; + /** + * @description Specifies the category purpose, as published in an external category purpose code list. + * External code sets can be downloaded from www.iso20022.org. + * + * @example 1234 + */ + ExternalCategoryPurpose1Code: string; + /** + * ExternalChargeType1Code + * @example 1234 + */ + ExternalChargeType1Code: string; + /** + * ExternalClearingSystemIdentification1Code + * @example 12345 + */ + ExternalClearingSystemIdentification1Code: string; + /** + * ExternalCreditorAgentInstruction1Code + * @example 1234 + */ + ExternalCreditorAgentInstruction1Code: string; + /** + * ExternalFinancialInstitutionIdentification1Code + * @example 1234 + */ + ExternalFinancialInstitutionIdentification1Code: string; + /** + * ExternalLocalInstrument1Code + * @example 12345 + */ + ExternalLocalInstrument1Code: string; + /** + * ExternalOrganisationIdentification1Code + * @example 1234 + */ + ExternalOrganisationIdentification1Code: string; + /** + * ExternalPaymentTransactionStatus1Code + * @example 1234 + */ + ExternalPaymentTransactionStatus1Code: string; + /** + * ExternalPersonIdentification1Code + * @example 1234 + */ + ExternalPersonIdentification1Code: string; + /** + * ExternalProxyAccountType1Code + * @example 1234 + */ + ExternalProxyAccountType1Code: string; + /** + * ExternalPurpose1Code + * @example 1234 + */ + ExternalPurpose1Code: string; + /** + * ExternalServiceLevel1Code + * @example 1234 + */ + ExternalServiceLevel1Code: string; + /** + * ExternalStatusReason1Code + * @example 1234 + */ + ExternalStatusReason1Code: string; + /** + * ExternalVerificationReason1Code + * @example 1234 + */ + ExternalVerificationReason1Code: string; + /** + * FinancialIdentificationSchemeName1Choice + * @example { + * "Cd": "BIC" + * } + */ + FinancialIdentificationSchemeName1Choice: { + Cd?: components["schemas"]["ExternalFinancialInstitutionIdentification1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * FinancialInstitutionIdentification18 + * @example { + * "BICFI": "BUKBGB22", + * "Nm": "Barclays Bank Plc", + * "PstlAdr": { + * "Ctry": "GB", + * "AdrLine": [ + * "1 Churchill Place", + * "London", + * "UK" + * ] + * } + * } + */ + FinancialInstitutionIdentification18: { + BICFI?: components["schemas"]["BICFIDec2014Identifier"]; + ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"]; + LEI?: components["schemas"]["LEIIdentifier"]; + Nm?: components["schemas"]["Max140Text"]; + PstlAdr?: components["schemas"]["PostalAddress24"]; + Othr?: components["schemas"]["GenericFinancialIdentification1"]; + }; + /** + * FinancialInstitutionIdentification23 + * @example { + * "BICFI": "BUKBGB22", + * "Nm": "Barclays Bank Plc", + * "PstlAdr": { + * "Ctry": "GB", + * "AdrLine": [ + * "1 Churchill Place", + * "London", + * "UK" + * ] + * } + * } + */ + FinancialInstitutionIdentification23: { + BICFI?: components["schemas"]["BICFIDec2014Identifier"]; + ClrSysMmbId?: components["schemas"]["ClearingSystemMemberIdentification2"]; + LEI?: components["schemas"]["LEIIdentifier"]; + Nm?: components["schemas"]["Max140Text"]; + PstlAdr?: components["schemas"]["PostalAddress27"]; + Othr?: components["schemas"]["GenericFinancialIdentification1"]; + }; + /** + * FxRequest_FICreditTransferProposal + * @example { + * "GrpHdr": { + * "MsgId": 123456789, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "CtrlSum": 100, + * "InitgPty": { + * "Nm": "Initiating Party Name", + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BIC" + * } + * } + * ] + * } + * } + * }, + * "FwdgAgt": { + * "FinInstnId": { + * "BICFI": "BICFID0" + * } + * }, + * "Dbtr": { + * "Nm": "Debtor Name", + * "PstlAdr": { + * "AdrLine": [ + * "Debtor Address Line 1", + * "Debtor Address Line 2" + * ] + * }, + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BIC" + * } + * } + * ] + * } + * } + * }, + * "DbtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * } + * }, + * "DbtrAgt": { + * "FinInstnId": { + * "BICFI": "BICFID0" + * } + * }, + * "Cdtr": { + * "Nm": "Creditor Name", + * "PstlAdr": { + * "AdrLine": [ + * "Creditor Address Line 1", + * "Creditor Address Line 2" + * ] + * }, + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BIC" + * } + * } + * ] + * } + * } + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * } + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "BICFID0" + * } + * }, + * "CdtTrfTxInf": [ + * { + * "PmtId": { + * "InstrId": 123456789, + * "EndToEndId": 123456789 + * }, + * "Amt": { + * "InstdAmt": { + * "Ccy": "EUR", + * "Amt": 100 + * } + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "BICFID0" + * } + * }, + * "Cdtr": { + * "Nm": "Creditor Name", + * "PstlAdr": { + * "AdrLine": [ + * "Creditor Address Line 1", + * "Creditor Address Line 2" + * ] + * }, + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BIC" + * } + * } + * ] + * } + * } + * } + * } + * ] + * } + * } + */ + FxRequest_FICreditTransferProposal: { + GrpHdr: components["schemas"]["GroupHeader113"]; + }; + /** + * FxResponse_FICreditTransferConfirmation + * @example { + * "GrpHdr": { + * "MsgId": "20191122-123456", + * "CreDtTm": "2019-11-22T12:34:56", + * "NbOfTxs": 1, + * "CtrlSum": 100, + * "InitgPty": { + * "Nm": "Initiating Party Name" + * }, + * "MsgRcpt": { + * "Nm": "Message Recipient Name" + * } + * }, + * "CdtTrfTxInf": { + * "PmtId": { + * "InstrId": "20191122-123456", + * "EndToEndId": "20191122-123456" + * }, + * "PmtTpInf": { + * "InstrPrty": "NORM", + * "CtgyPurp": "SUPP" + * }, + * "IntrBkSttlmAmt": { + * "Amt": 100, + * "Ccy": "EUR" + * }, + * "ChrgBr": "SLEV", + * "Cdtr": { + * "Nm": "Creditor Name" + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Tp": { + * "Cd": "CACC" + * }, + * "Ccy": "EUR", + * "Nm": "My account" + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "BNBABEBB" + * } + * }, + * "CdtrAgtAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Tp": { + * "Cd": "CACC" + * }, + * "Ccy": "EUR", + * "Nm": "My account" + * }, + * "Dbtr": { + * "Nm": "Debtor Name" + * }, + * "DbtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Tp": { + * "Cd": "CACC" + * }, + * "Ccy": "EUR", + * "Nm": "My account" + * }, + * "DbtrAgt": { + * "FinInstnId": { + * "BICFI": "BNBABEBB" + * } + * }, + * "DbtrAgtAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Tp": { + * "Cd": "CACC" + * }, + * "Ccy": "EUR", + * "Nm": "My account" + * }, + * "RmtInf": { + * "Ustrd": "Remittance Information" + * }, + * "RgltryRptg": { + * "Dbtr": { + * "Nm": "Debtor Name" + * }, + * "DbtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Tp": { + * "Cd": "CACC" + * }, + * "Ccy": "EUR", + * "Nm": "My account" + * } + * } + * } + * } + */ + FxResponse_FICreditTransferConfirmation: { + GrpHdr: components["schemas"]["GroupHeader113"]; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"]; + }; + /** + * Fxecute_FinancialInstitutionCreditTransferV12 + * @example { + * "GrpHdr": { + * "MsgId": 20191113001, + * "CreDtTm": "2019-11-13T10:00:00", + * "NbOfTxs": 1, + * "CtrlSum": 1000, + * "InitgPty": { + * "Nm": "Initiating Party Name", + * "Id": { + * "OrgId": { + * "Othr": { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BBA" + * } + * } + * } + * } + * }, + * "FwdgAgt": { + * "FinInstnId": { + * "BICFI": "BBBBBBBB" + * } + * }, + * "DbtrAgt": { + * "FinInstnId": { + * "BICFI": "AAAAAAAA" + * } + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "CCCCCCCC" + * } + * } + * }, + * "CdtTrfTxInf": { + * "PmtId": { + * "InstrId": 20191113001, + * "EndToEndId": 20191113001 + * }, + * "PmtTpInf": { + * "InstrPrty": "NORM", + * "CtgyPurp": { + * "Cd": "SUPP" + * } + * }, + * "InstrForCdtrAgt": { + * "Cd": "/ACC/123456789" + * }, + * "IntrBkSttlmAmt": { + * "Amt": 1000, + * "Ccy": "EUR" + * }, + * "ChrgBr": "SLEV", + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "CCCCCCCC" + * } + * }, + * "Cdtr": { + * "Nm": "Creditor Name" + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * } + * }, + * "RmtInf": { + * "Ustrd": "Payment for invoice 12345" + * } + * } + * } + */ + Fxecute_FinancialInstitutionCreditTransferV12: { + GrpHdr: components["schemas"]["GroupHeader129"]; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"]; + }; + /** + * GenericAccountIdentification1 + * @example { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + */ + GenericAccountIdentification1: { + Id: components["schemas"]["Max34Text"]; + SchmeNm?: components["schemas"]["AccountSchemeName1Choice"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GenericFinancialIdentification1 + * @example { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + */ + GenericFinancialIdentification1: { + Id: components["schemas"]["Max35Text"]; + SchmeNm?: components["schemas"]["FinancialIdentificationSchemeName1Choice"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GenericIdentification3 + * @example { + * "Id": 123, + * "Issr": "BIC" + * } + */ + GenericIdentification3: { + Id: components["schemas"]["Max35Text"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GenericIdentification30 + * @example { + * "Id": 1234, + * "Issr": "BIC", + * "SchmeNm": "BICFI" + * } + */ + GenericIdentification30: { + Id: components["schemas"]["Exact4AlphaNumericText"]; + Issr: components["schemas"]["Max35Text"]; + SchmeNm?: components["schemas"]["Max35Text"]; + }; + /** + * GenericOrganisationIdentification1 + * @example { + * "Id": 123, + * "SchmeNm": { + * "Cd": "BIC" + * }, + * "Issr": "BIC" + * } + */ + GenericOrganisationIdentification1: { + Id: components["schemas"]["Max35Text"]; + SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GenericOrganisationIdentification3 + * @example { + * "Id": 123, + * "SchmeNm": { + * "Cd": "BIC" + * }, + * "Issr": "BIC" + * } + */ + GenericOrganisationIdentification3: { + Id: components["schemas"]["Max256Text"]; + SchmeNm?: components["schemas"]["OrganisationIdentificationSchemeName1Choice"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GenericPersonIdentification1 + * @example { + * "Id": 123, + * "SchmeNm": { + * "Cd": "DRLC" + * }, + * "Issr": "BIC" + * } + */ + GenericPersonIdentification1: { + Id: components["schemas"]["Max35Text"]; + SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GenericPersonIdentification2 + * @example { + * "Id": 123, + * "SchmeNm": { + * "Cd": "DRLC" + * }, + * "Issr": "BIC" + * } + */ + GenericPersonIdentification2: { + Id: components["schemas"]["Max256Text"]; + SchmeNm?: components["schemas"]["PersonIdentificationSchemeName1Choice"]; + Issr?: components["schemas"]["Max35Text"]; + }; + /** + * GetPartiesError_IdentificationVerificationReportV03 + * @example { + * "Assgnmt": { + * "Id": 123, + * "CreDtTm": "2013-03-07T16:30:00", + * "Assgnr": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * }, + * "Assgne": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * } + * }, + * "Rpt": { + * "Id": 123, + * "CreDtTm": "2013-03-07T16:30:00", + * "RptgPty": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * }, + * "RptdPty": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * }, + * "RptdDoc": { + * "Nb": 123, + * "RltdDt": "2013-03-07", + * "RltdDtTp": { + * "Cd": 123 + * } + * }, + * "Rsn": { + * "Cd": 123, + * "Prtry": 123 + * } + * }, + * "SplmtryData": { + * "PlcAndNm": 123, + * "Envlp": 123, + * "RltdDt": "2013-03-07", + * "RltdDtTp": { + * "Cd": 123 + * } + * } + * } + */ + GetPartiesError_IdentificationVerificationReportV03: { + Assgnmt: components["schemas"]["IdentificationAssignment3"]; + Rpt: components["schemas"]["VerificationReport4"]; + SplmtryData?: components["schemas"]["SupplementaryData1"]; + }; + /** + * GetParties_IdentificationVerificationReportV03 + * @example { + * "Assgnmt": { + * "Id": 123, + * "CreDtTm": "2013-03-07T16:30:00", + * "Assgnr": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * }, + * "Assgne": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * } + * }, + * "Rpt": { + * "Id": 123, + * "CreDtTm": "2013-03-07T16:30:00", + * "RptgPty": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * }, + * "RptdPty": { + * "Id": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * }, + * "RptdDoc": { + * "Nb": 123, + * "RltdDt": "2013-03-07", + * "RltdDtTp": { + * "Cd": 123 + * } + * }, + * "Rsn": { + * "Cd": 123, + * "Prtry": 123 + * } + * }, + * "SplmtryData": { + * "PlcAndNm": 123, + * "Envlp": 123, + * "RltdDt": "2013-03-07", + * "RltdDtTp": { + * "Cd": 123 + * } + * } + * } + */ + GetParties_IdentificationVerificationReportV03: { + Assgnmt: components["schemas"]["IdentificationAssignment3"]; + Rpt: components["schemas"]["VerificationReport4"]; + SplmtryData?: components["schemas"]["SupplementaryData1"]; + }; + /** + * GroupHeader113 + * @description Set of characteristics shared by all individual transactions included in the message. + * + * @example { + * "MsgId": 12345, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "TtlIntrBkSttlmAmt": { + * "Ccy": "EUR", + * "Value": 100 + * }, + * "SttlmInf": { + * "SttlmMtd": "INDA", + * "SttlmAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Ccy": "EUR" + * }, + * "SttlmAcctOwnr": { + * "Nm": "Name" + * }, + * "SttlmAcctSvcr": { + * "Nm": "Name" + * }, + * "SttlmAgt": { + * "FinInstnId": { + * "BICFI": "BIC" + * } + * } + * }, + * "PmtTpInf": { + * "InstrPrty": "NORM", + * "CtgyPurp": "CASH" + * }, + * "CdtTrfTxInf": { + * "PmtId": { + * "InstrId": 12345, + * "EndToEndId": 12345 + * }, + * "Amt": { + * "InstdAmt": { + * "Ccy": "EUR", + * "Value": 100 + * } + * }, + * "Cdtr": { + * "Nm": "Name" + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Ccy": "EUR" + * }, + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": "BIC" + * } + * }, + * "CdtrAgtAcct": { + * "Id": { + * "IBAN": "BE71096123456769" + * }, + * "Ccy": "EUR" + * }, + * "RmtInf": { + * "Ustrd": "Test" + * } + * } + * } + */ + GroupHeader113: { + MsgId: components["schemas"]["Max35Text"]; + CreDtTm: components["schemas"]["ISODateTime"]; + NbOfTxs: components["schemas"]["Max15NumericText"]; + TtlIntrBkSttlmAmt?: components["schemas"]["ActiveCurrencyAndAmount"]; + SttlmInf: components["schemas"]["SettlementInstruction15"]; + PmtTpInf?: components["schemas"]["PaymentTypeInformation28"]; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction68"]; + }; + /** + * GroupHeader120 + * @description Set of characteristics shared by all individual transactions included in the message. + * + * @example { + * "MsgId": 12345, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "TxInfAndSts": { + * "StsId": 12345, + * "OrgnlInstrId": 12345, + * "OrgnlEndToEndId": 12345, + * "OrgnlTxId": 12345, + * "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + * "TxSts": "RJCT", + * "StsRsnInf": { + * "Rsn": "RSN", + * "AddtlInf": "ADDITIONAL" + * }, + * "AccptncDtTm": "2020-01-01T00:00:00Z", + * "AcctSvcrRef": "ACCTSVCRREF", + * "ClrSysRef": "CLRSYSREF", + * "ExctnConf": "1234567890ABCDEF", + * "SplmtryData": { + * "PlcAndNm": "PLACE", + * "Envlp": "ENVELOPE" + * } + * } + * } + */ + GroupHeader120: { + MsgId: components["schemas"]["Max35Text"]; + CreDtTm: components["schemas"]["ISODateTime"]; + TxInfAndSts?: components["schemas"]["PaymentTransaction163"]; + }; + /** + * GroupHeader129 + * @description Set of characteristics shared by all individual transactions included in the message. + * + * @example { + * "MsgId": 12345, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "PmtInstrXpryDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "SttlmInf": { + * "SttlmMtd": "INDA", + * "SttlmAcct": { + * "Id": { + * "IBAN": 123 + * } + * }, + * "SttlmAcctOwnr": { + * "Nm": "John Doe" + * }, + * "SttlmAcctSvcr": { + * "BICFI": 123 + * } + * }, + * "CdtTrfTxInf": { + * "PmtId": { + * "InstrId": 123, + * "EndToEndId": 123 + * }, + * "PmtTpInf": { + * "InstrPrty": "NORM" + * }, + * "InstdAmt": { + * "Amt": 123, + * "Ccy": "EUR" + * }, + * "ChrgBr": "SLEV", + * "CdtrAgt": { + * "FinInstnId": { + * "BICFI": 123 + * } + * }, + * "Cdtr": { + * "Nm": "John Doe" + * }, + * "CdtrAcct": { + * "Id": { + * "IBAN": 123 + * } + * }, + * "RmtInf": { + * "Ustrd": "Test" + * } + * } + * } + */ + GroupHeader129: { + MsgId: components["schemas"]["Max35Text"]; + CreDtTm: components["schemas"]["ISODateTime"]; + PmtInstrXpryDtTm?: components["schemas"]["ISODateTime"]; + NbOfTxs: components["schemas"]["Max15NumericText"]; + SttlmInf: components["schemas"]["SettlementInstruction15"]; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"]; + }; + /** + * IBAN2007Identifier + * @description The International Bank Account Number is a code used internationally by financial institutions to uniquely identify the account of a customer at a financial institution as described in the 2007 edition of the ISO 13616 standard "Banking and related financial services - + * International Bank Account Number (IBAN)" and replaced by the more recent edition of the standard. + * + * @example FR1420041010050500013M02606 + */ + IBAN2007Identifier: string; + /** + * ISODate + * Format: date + * @description A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601. + * + * @example 2013-03-07 + */ + ISODate: string; + /** + * ISODateTime + * Format: datetime + * @description A particular point in the progression of time defined by a mandatory + * date and a mandatory time component, expressed in either UTC time + * format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format + * (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format + * (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in + * "XML Schema Part 2: Datatypes Second Edition - + * W3C Recommendation 28 October 2004" which is aligned with ISO 8601. + * + * Note on the time format: + * 1) beginning / end of calendar day + * 00:00:00 = the beginning of a calendar day + * 24:00:00 = the end of a calendar day + * + * 2) fractions of second in time format + * Decimal fractions of seconds may be included. In this case, the + * involved parties shall agree on the maximum number of digits that are allowed. + * + * @example 2013-03-07T14:44:30.000Z + */ + ISODateTime: string; + /** + * ISOYear + * @description Year represented by YYYY (ISO 8601). + * + * @example 2019 + */ + ISOYear: string; + /** + * IdentificationAssignment3 + * @example { + * "MsgId": 123, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "Assgnr": { + * "OrgId": { + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "BIC" + * }, + * "Issr": "BIC" + * } + * } + * }, + * "Assgne": { + * "OrgId": { + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "BIC" + * }, + * "Issr": "BIC" + * } + * } + * } + * } + */ + IdentificationAssignment3: { + MsgId: components["schemas"]["Max35Text"]; + CreDtTm: components["schemas"]["ISODateTime"]; + Assgnr: components["schemas"]["Party40Choice"]; + Assgne: components["schemas"]["Party40Choice"]; + }; + /** + * IdentificationInformation4 + * @example { + * "Pty": { + * "Id": { + * "OrgId": { + * "AnyBIC": { + * "BICFI": "BICFI" + * } + * } + * }, + * "CtryOfRes": "FI" + * }, + * "Acct": { + * "Id": { + * "IBAN": "FI2112345600000785" + * } + * }, + * "Agt": { + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * } + * } + */ + IdentificationInformation4: { + Pty?: components["schemas"]["PartyIdentification135"]; + Acct?: components["schemas"]["CashAccount40"]; + Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"]; + }; + /** + * IdentificationVerificationIndicator + * @example true + */ + IdentificationVerificationIndicator: boolean; + /** + * Instruction4Code + * @description Specifies further instructions concerning the processing of a payment instruction, provided by the sending clearing agent to the next agent(s). + * PHOA PhoneNextAgent Please advise/contact next agent by phone. + * TELA TelecomNextAgent Please advise/contact next agent by the most efficient means of telecommunication. + * + * @example PHOA + * @enum {string} + */ + Instruction4Code: "PHOA" | "TELA"; + /** + * InstructionForCreditorAgent3 + * @description Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. + * + * @example { + * "Cd": "PHOA", + * "InstrInf": "Please advise/contact next agent by phone." + * } + */ + InstructionForCreditorAgent3: { + Cd?: components["schemas"]["ExternalCreditorAgentInstruction1Code"]; + InstrInf?: components["schemas"]["Max140Text"]; + }; + /** + * InstructionForNextAgent1 + * @description Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent. + * + * @example { + * "Cd": "PHOA", + * "InstrInf": "Please advise/contact next agent by phone" + * } + */ + InstructionForNextAgent1: { + Cd?: components["schemas"]["Instruction4Code"]; + InstrInf?: components["schemas"]["Max140Text"]; + }; + /** + * LEIIdentifier + * @description Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". ^([0-9A-Z]{18,18}[0-9]{2,2})$ + * + * @example 529900T8BM49AURSDO55 + */ + LEIIdentifier: string; + /** + * LocalInstrument2Choice + * @example { + * "Cd": "CH03" + * } + */ + LocalInstrument2Choice: { + Cd?: components["schemas"]["ExternalLocalInstrument1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * Max105Text + * @description Specifies a character string with a maximum length of 105 characters. + * + * @example 12345 + */ + Max105Text: string; + /** + * Max10Text + * @description Specifies a character string with a maximum length of 10 characters. + * + * @example 1234567890 + */ + Max10Text: string; + /** + * Max128Text + * @description Specifies a character string with a maximum length of 128 characters. + * + * @example 12345 + */ + Max128Text: string; + /** + * Max140Text + * @description Specifies a character string with a maximum length of 140 characters. + * + * @example 12345 + */ + Max140Text: string; + /** + * Max15NumericText + * @description Specifies a numeric string with a maximum length of 15 digits. + * + * @example 123456789012345 + */ + Max15NumericText: string; + /** + * Max16Text + * @description Specifies a character string with a maximum length of 16 characters. + * + * @example 1234567890123456 + */ + Max16Text: string; + /** + * Max2048Text + * @description Specifies a character string with a maximum length of 2048 characters. + * + * @example 2048 + */ + Max2048Text: string; + /** + * Max256Text + * @description Specifies a character string with a maximum length of 256 characters. + * + * @example 256 + */ + Max256Text: string; + /** + * Max34Text + * @description Specifies a character string with a maximum length of 34 characters. + * + * @example 1.2345678901234568e+33 + */ + Max34Text: string; + /** + * Max350Text + * @description Specifies a character string with a maximum length of 350 characters. + * + * @example 350 + */ + Max350Text: string; + /** + * Max35Text + * @description Specifies a character string with a maximum length of 35 characters. + * + * @example 1.234567890123457e+34 + */ + Max35Text: string; + /** + * Max4Text + * @description Specifies a character string with a maximum length of 4 characters. + * + * @example 1234 + */ + Max4Text: string; + /** + * Max70Text + * @description Specifies a character string with a maximum length of 70 characters. + * + * @example 1.2345678901234567e+99 + */ + Max70Text: string; + /** + * @description Specifies the terms used to formally address a person. + * + * @example DOCT + * @enum {string} + */ + NamePrefix2Code: "DOCT" | "MADM" | "MISS" | "MIST" | "MIKS"; + /** + * Number + * @example 256 + */ + Number: string; + /** + * OrganisationIdentification29 + * @description Unique and unambiguous way to identify an organisation. + * + * @example { + * "AnyBIC": "BICFI", + * "LEI": "529900T8BM49AURSDO55", + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "BIC" + * }, + * "Issr": "BIC" + * } + * } + */ + OrganisationIdentification29: { + AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"]; + LEI?: components["schemas"]["LEIIdentifier"]; + Othr?: components["schemas"]["GenericOrganisationIdentification1"]; + }; + /** + * OrganisationIdentification39 + * @description Unique and unambiguous way to identify an organisation. + * + * @example { + * "AnyBIC": "BICFI", + * "LEI": "529900T8BM49AURSDO55", + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "BIC" + * }, + * "Issr": "BIC" + * } + * } + */ + OrganisationIdentification39: { + AnyBIC?: components["schemas"]["AnyBICDec2014Identifier"]; + LEI?: components["schemas"]["LEIIdentifier"]; + Othr?: components["schemas"]["GenericOrganisationIdentification3"]; + }; + /** + * OrganisationIdentificationSchemeName1Choice + * @description Choice of format for the organisation identification. + * + * @example { + * "Cd": "BIC" + * } + */ + OrganisationIdentificationSchemeName1Choice: { + Cd?: components["schemas"]["ExternalOrganisationIdentification1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * OtherContact1 + * @description Communication device number or electronic address used for communication. + * + * @example { + * "ChanlTp": "PHON", + * "Id": 1234567890 + * } + */ + OtherContact1: { + ChanlTp: components["schemas"]["Max4Text"]; + Id?: components["schemas"]["Max128Text"]; + }; + /** + * PacsError_FIToFIPaymentStatusReportV15 + * @example { + * "GrpHdr": { + * "MsgId": 12345, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "SttlmInf": { + * "SttlmMtd": "INDA", + * "SttlmDt": "2020-01-01" + * }, + * "InstgAgt": { + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * }, + * "InstdAgt": { + * "FinInstnId": { + * "BICFI": "BICFI" + * } + * } + * }, + * "TxInfAndSts": { + * "OrgnlInstrId": 12345, + * "OrgnlEndToEndId": 12345, + * "TxSts": "RJCT", + * "StsRsnInf": { + * "Rsn": "RSN", + * "AddtlInf": "ADDITIONAL" + * } + * }, + * "SplmtryData": { + * "PlcAndNm": "PLACE", + * "Envlp": "ENVELOPE" + * } + * } + */ + PacsError_FIToFIPaymentStatusReportV15: { + GrpHdr: components["schemas"]["GroupHeader120"]; + TxInfAndSts?: components["schemas"]["PaymentTransaction163"]; + SplmtryData?: components["schemas"]["SupplementaryData1"]; + }; + /** + * PacsStatus_FIToFIPaymentStatusReportV15 + * @description Unsure on description. + * + * @example { + * "GrpHdr": { + * "MsgId": 123, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "SttlmInf": { + * "SttlmMtd": "INDA", + * "SttlmDt": "2020-01-01", + * "SttlmTmIndctn": "RTGS", + * "SttlmTmReq": "2020-01-01T00:00:00Z", + * "SttlmAcct": { + * "Id": { + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * } + * }, + * "ClrSys": { + * "Prtry": 123 + * }, + * "InstgAgt": { + * "FinInstnId": { + * "BICFI": 123 + * } + * }, + * "InstdAgt": { + * "FinInstnId": { + * "BICFI": 123 + * } + * } + * }, + * "InstgAgt": { + * "FinInstnId": { + * "BICFI": 123 + * } + * }, + * "InstdAgt": { + * "FinInstnId": { + * "BICFI": 123 + * } + * }, + * "IntrBkSttlmAmt": { + * "Amt": 123, + * "Ccy": "EUR" + * }, + * "IntrBkSttlmDt": "2020-01-01", + * "TxSts": "ACCP", + * "StsRsnInf": { + * "Orgtr": { + * "Id": { + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * } + * }, + * "Rsn": { + * "Cd": 123, + * "Prtry": 123 + * } + * }, + * "TxInfAndSts": { + * "OrgnlInstrId": 123, + * "OrgnlEndToEndId": 123, + * "TxSts": "ACCP", + * "StsRsnInf": { + * "Orgtr": { + * "Id": { + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN" + * }, + * "Issr": "BIC" + * } + * } + * }, + * "Rsn": { + * "Cd": 123, + * "Prtry": 123 + * } + * }, + * "ChrgsInf": { + * "Amt": 123, + * "Ccy": "EUR" + * }, + * "IntrBkSttlmAmt": { + * "Amt": 123, + * "Ccy": "EUR" + * }, + * "IntrBkSttlmDt": "2020-01-01", + * "SttlmTmIndctn": "RTGS" + * } + * } + * } + */ + PacsStatus_FIToFIPaymentStatusReportV15: { + GrpHdr: components["schemas"]["GroupHeader120"]; + }; + /** + * Party38Choice + * @description Nature or use of the account. + * + * @example { + * "OrgId": { + * "AnyBIC": "BIC" + * }, + * "PrvtId": { + * "DtAndPlcOfBirth": { + * "Dt": "2018-01-01", + * "CityOfBirth": "City" + * } + * } + * } + */ + Party38Choice: { + OrgId?: components["schemas"]["OrganisationIdentification29"]; + PrvtId?: components["schemas"]["PersonIdentification13"]; + } & (unknown | unknown); + /** + * Party40Choice + * @description Nature or use of the account. + * + * @example { + * "Pty": { + * "Nm": "Name", + * "PstlAdr": { + * "Ctry": "US", + * "AdrLine": [ + * "Line1", + * "Line2" + * ] + * }, + * "Id": { + * "OrgId": { + * "AnyBIC": "BIC" + * } + * } + * }, + * "Agt": { + * "FinInstnId": { + * "BICFI": "BUKBGB22" + * }, + * "BrnchId": { + * "Id": 12345, + * "Nm": "Oxford Street Branch", + * "PstlAdr": { + * "Ctry": "GB", + * "AdrLine": [ + * "1 Oxford Street", + * "London", + * "UK" + * ] + * } + * } + * } + * } + */ + Party40Choice: { + Pty?: components["schemas"]["PartyIdentification135"]; + Agt?: components["schemas"]["BranchAndFinancialInstitutionIdentification6"]; + } & (unknown | unknown); + /** + * Party52Choice + * @description Nature or use of the account. + * + * @example { + * "OrgId": { + * "AnyBIC": "BIC" + * }, + * "PrvtId": { + * "DtAndPlcOfBirth": { + * "Dt": "2018-01-01", + * "CityOfBirth": "City" + * } + * } + * } + */ + Party52Choice: { + OrgId?: components["schemas"]["OrganisationIdentification39"]; + PrvtId?: components["schemas"]["PersonIdentification18"]; + } & (unknown | unknown); + /** + * PartyIdentification135 + * @description Specifies the identification of a person or an organisation. + * + * @example { + * "Nm": "John Doe", + * "PstlAdr": { + * "Ctry": "BE", + * "AdrLine": [ + * "Rue du Marché 45", + * "Brussels", + * "BE" + * ] + * }, + * "Id": { + * "OrgId": { + * "AnyBIC": "CCCCUS33" + * } + * }, + * "CtryOfRes": "BE", + * "CtctDtls": { + * "NmPrfx": "Mr", + * "Nm": "John Doe", + * "PhneNb": "+123-123-321", + * "MobNb": "+123-123-321", + * "FaxNb": "+123-123-321", + * "EmailAdr": null + * } + * } + */ + PartyIdentification135: { + Nm?: components["schemas"]["Max140Text"]; + PstlAdr?: components["schemas"]["PostalAddress24"]; + Id?: components["schemas"]["Party38Choice"]; + CtryOfRes?: components["schemas"]["CountryCode"]; + CtctDtls?: components["schemas"]["Contact4"]; + }; + /** + * PartyIdentification272 + * @description Specifies the identification of a person or an organisation. + * + * @example { + * "Nm": "John Doe", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "Dept": "Dept", + * "SubDept": "SubDept", + * "StrtNm": "StrtNm", + * "BldgNb": "BldgNb", + * "PstCd": "PstCd", + * "TwnNm": "TwnNm", + * "CtrySubDvsn": "CtrySubDvsn", + * "Ctry": "Ctry" + * }, + * "Id": { + * "OrgId": { + * "AnyBIC": "BIC" + * }, + * "PrvtId": { + * "DtAndPlcOfBirth": { + * "Dt": "2018-01-01", + * "CityOfBirth": "City" + * } + * } + * }, + * "CtryOfRes": "BE", + * "CtctDtls": { + * "NmPrfx": "Mr", + * "Nm": "John Doe", + * "PhneNb": "+123-123-321", + * "MobNb": "+123-123-321", + * "FaxNb": "+123-123-321", + * "EmailAdr": null + * } + * } + */ + PartyIdentification272: { + Nm?: components["schemas"]["Max140Text"]; + PstlAdr?: components["schemas"]["PostalAddress27"]; + Id?: components["schemas"]["Party52Choice"]; + CtryOfRes?: components["schemas"]["CountryCode"]; + CtctDtls?: components["schemas"]["Contact13"]; + }; + /** + * PaymentIdentification13 + * @description Provides further means of referencing a payment transaction. + * + * @example { + * "InstrId": "INSTRUCTIONID", + * "EndToEndId": "ENDTOENDID", + * "TxId": "TRANSACTIONID", + * "UETR": "123e4567-e89b-12d3-a456-426614174000", + * "ClrSysRef": "CLRSYSREF" + * } + */ + PaymentIdentification13: { + InstrId?: components["schemas"]["Max35Text"]; + EndToEndId: components["schemas"]["Max35Text"]; + TxId?: components["schemas"]["Max35Text"]; + UETR?: components["schemas"]["UUIDv4Identifier"]; + ClrSysRef?: components["schemas"]["Max35Text"]; + }; + /** + * PaymentTransaction163 + * @description Provides further details on the original transactions, to which the status report message refers. + * + * @example { + * "StsId": 12345, + * "OrgnlInstrId": 12345, + * "OrgnlEndToEndId": 12345, + * "OrgnlTxId": 12345, + * "OrgnlUETR": "123e4567-e89b-12d3-a456-426614174000", + * "TxSts": "RJCT", + * "StsRsnInf": { + * "Rsn": "RSN", + * "AddtlInf": "ADDITIONAL" + * }, + * "AccptncDtTm": "2020-01-01T00:00:00Z", + * "AcctSvcrRef": "ACCTSVCRREF", + * "ClrSysRef": "CLRSYSREF", + * "ExctnConf": "1234567890ABCDEF", + * "SplmtryData": { + * "PlcAndNm": "PLACE", + * "Envlp": "ENVELOPE" + * } + * } + */ + PaymentTransaction163: { + StsId?: components["schemas"]["Max35Text"]; + OrgnlInstrId?: components["schemas"]["Max35Text"]; + OrgnlEndToEndId?: components["schemas"]["Max35Text"]; + OrgnlTxId?: components["schemas"]["Max35Text"]; + OrgnlUETR?: components["schemas"]["UUIDv4Identifier"]; + TxSts?: components["schemas"]["ExternalPaymentTransactionStatus1Code"]; + StsRsnInf?: components["schemas"]["StatusReasonInformation14"]; + AccptncDtTm?: components["schemas"]["ISODateTime"]; + AcctSvcrRef?: components["schemas"]["Max35Text"]; + ClrSysRef?: components["schemas"]["Max35Text"]; + ExctnConf?: components["schemas"]["Exact32HexBinaryText"]; + SplmtryData?: components["schemas"]["SupplementaryData1"]; + }; + /** + * PaymentTypeInformation28 + * @description Provides further details of the type of payment. + * + * @example { + * "InstrPrty": "NORM", + * "ClrChanl": "RTGS", + * "SvcLvl": { + * "Cd": "SEPA" + * }, + * "LclInstrm": { + * "Cd": "CORE" + * }, + * "CtgyPurp": { + * "Cd": "CASH" + * } + * } + */ + PaymentTypeInformation28: { + InstrPrty?: components["schemas"]["Priority2Code"]; + ClrChanl?: components["schemas"]["ClearingChannel2Code"]; + SvcLvl?: components["schemas"]["ServiceLevel8Choice"]; + LclInstrm?: components["schemas"]["LocalInstrument2Choice"]; + CtgyPurp?: components["schemas"]["CategoryPurpose1Choice"]; + }; + /** + * PercentageRate + * @example 1234 + */ + PercentageRate: string; + /** + * PersonIdentification13 + * @description Unique and unambiguous way to identify a person. + * + * @example { + * "DtAndPlcOfBirth": { + * "Dt": "2018-01-01", + * "CityOfBirth": "City" + * }, + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "CUST", + * "Prtry": 1 + * } + * } + * } + */ + PersonIdentification13: { + DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"]; + Othr?: components["schemas"]["GenericPersonIdentification1"]; + }; + /** + * PersonIdentification18 + * @description Unique and unambiguous way to identify a person. + * + * @example { + * "DtAndPlcOfBirth": { + * "Dt": "2018-01-01", + * "CityOfBirth": "City" + * }, + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "CUST", + * "Prtry": 1 + * } + * } + * } + */ + PersonIdentification18: { + DtAndPlcOfBirth?: components["schemas"]["DateAndPlaceOfBirth1"]; + Othr?: components["schemas"]["GenericPersonIdentification2"]; + }; + /** + * PersonIdentificationSchemeName1Choice + * @description Sets of elements to identify a name of the identification scheme. + * + * @example { + * "Cd": "CCPT" + * } + */ + PersonIdentificationSchemeName1Choice: { + Cd?: components["schemas"]["ExternalPersonIdentification1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * PhoneNumber + * @description Double check this regex. + * + */ + PhoneNumber: string; + /** + * PostalAddress24 + * @description Information that locates and identifies a specific address, as defined by postal services. + * + * @example { + * "AdrTp": "ADDR", + * "Dept": "Dept", + * "SubDept": "SubDept", + * "StrtNm": "StrtNm", + * "BldgNb": "BldgNb", + * "BldgNm": "BldgNm", + * "Flr": "Flr", + * "PstBx": "PstBx", + * "Room": "Room", + * "PstCd": "PstCd", + * "TwnNm": "TwnNm", + * "TwnLctnNm": "TwnLctnNm", + * "DstrctNm": "DstrctNm", + * "CtrySubDvsn": "CtrySubDvsn", + * "Ctry": "Ctry", + * "AdrLine": "AdrLine" + * } + */ + PostalAddress24: { + AdrTp?: components["schemas"]["AddressType3Choice"]; + Dept?: components["schemas"]["Max70Text"]; + SubDept?: components["schemas"]["Max70Text"]; + StrtNm?: components["schemas"]["Max70Text"]; + BldgNb?: components["schemas"]["Max16Text"]; + BldgNm?: components["schemas"]["Max35Text"]; + Flr?: components["schemas"]["Max70Text"]; + PstBx?: components["schemas"]["Max16Text"]; + Room?: components["schemas"]["Max70Text"]; + PstCd?: components["schemas"]["Max16Text"]; + TwnNm?: components["schemas"]["Max35Text"]; + TwnLctnNm?: components["schemas"]["Max35Text"]; + DstrctNm?: components["schemas"]["Max35Text"]; + CtrySubDvsn?: components["schemas"]["Max35Text"]; + Ctry?: components["schemas"]["CountryCode"]; + AdrLine?: components["schemas"]["Max70Text"]; + }; + /** + * PostalAddress27 + * @description Information that locates and identifies a specific address, as defined by postal services. + * + * @example { + * "AdrTp": "ADDR", + * "CareOf": "CareOf", + * "Dept": "Dept", + * "SubDept": "SubDept", + * "StrtNm": "StrtNm", + * "BldgNb": "BldgNb", + * "BldgNm": "BldgNm", + * "Flr": "Flr", + * "UnitNb": "UnitNb", + * "PstBx": "PstBx", + * "Room": "Room", + * "PstCd": "PstCd", + * "TwnNm": "TwnNm", + * "TwnLctnNm": "TwnLctnNm", + * "DstrctNm": "DstrctNm", + * "CtrySubDvsn": "CtrySubDvsn", + * "Ctry": "Ctry", + * "AdrLine": "AdrLine" + * } + */ + PostalAddress27: { + AdrTp?: components["schemas"]["AddressType3Choice"]; + CareOf?: components["schemas"]["Max140Text"]; + Dept?: components["schemas"]["Max70Text"]; + SubDept?: components["schemas"]["Max70Text"]; + StrtNm?: components["schemas"]["Max140Text"]; + BldgNb?: components["schemas"]["Max16Text"]; + BldgNm?: components["schemas"]["Max140Text"]; + Flr?: components["schemas"]["Max70Text"]; + UnitNb?: components["schemas"]["Max16Text"]; + PstBx?: components["schemas"]["Max16Text"]; + Room?: components["schemas"]["Max70Text"]; + PstCd?: components["schemas"]["Max16Text"]; + TwnNm?: components["schemas"]["Max140Text"]; + TwnLctnNm?: components["schemas"]["Max140Text"]; + DstrctNm?: components["schemas"]["Max140Text"]; + CtrySubDvsn?: components["schemas"]["Max35Text"]; + Ctry?: components["schemas"]["CountryCode"]; + AdrLine?: components["schemas"]["Max70Text"]; + }; + /** + * PreferredContactMethod1Code + * @description Preferred method used to reach the individual contact within an organisation. + * + * @example CELL + * @enum {string} + */ + PreferredContactMethod1Code: "LETT" | "MAIL" | "PHON" | "FAXX" | "CELL"; + /** + * PreferredContactMethod2Code + * @description Preferred method used to reach the individual contact within an organisation. + * + * @example MAIL + * @enum {string} + */ + PreferredContactMethod2Code: "LETT" | "MAIL" | "PHON" | "FAXX" | "CELL"; + /** + * Priority2Code + * @description Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. + * + * @example HIGH + * @enum {string} + */ + Priority2Code: "HIGH" | "NORM"; + /** + * ProxyAccountIdentification1 + * @description Information related to a proxy identification of the account. + * + * @example { + * "Tp": { + * "Cd": "IBAN" + * }, + * "Id": 123 + * } + */ + ProxyAccountIdentification1: { + Tp?: components["schemas"]["ProxyAccountType1Choice"]; + Id: components["schemas"]["Max2048Text"]; + }; + /** + * ProxyAccountType1Choice + * @description NOTE: Unsure on description. + * + * @example { + * "Cd": "CH03" + * } + */ + ProxyAccountType1Choice: { + Cd?: components["schemas"]["ExternalProxyAccountType1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * Purpose2Choice + * @description Specifies the underlying reason for the payment transaction. + * Usage: Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain. + * + * @example { + * "Cd": "CH03" + * } + */ + Purpose2Choice: { + Cd?: components["schemas"]["ExternalPurpose1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * RegulatoryAuthority2 + * @description Information about an entity requiring the regulatory reporting information. + * + * @example { + * "Nm": "Swiss National Bank", + * "Ctry": "CH" + * } + */ + RegulatoryAuthority2: { + Nm?: components["schemas"]["Max140Text"]; + Ctry?: components["schemas"]["CountryCode"]; + }; + /** + * RegulatoryReporting3 + * @description Information needed due to regulatory and/or statutory requirements. + * + * @example { + * "DbtCdtRptgInd": "CRED", + * "Authrty": { + * "Nm": "Swiss National Bank", + * "Ctry": "CH" + * }, + * "Dtls": { + * "Cd": "A1", + * "Inf": "Mandatory regulatory information" + * } + * } + */ + RegulatoryReporting3: { + DbtCdtRptgInd?: components["schemas"]["RegulatoryReportingType1Code"]; + Authrty?: components["schemas"]["RegulatoryAuthority2"]; + Dtls?: components["schemas"]["StructuredRegulatoryReporting3"]; + }; + /** + * RegulatoryReportingType1Code + * @description Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. + * + * @example BOTH + * @enum {string} + */ + RegulatoryReportingType1Code: "CRED" | "DEBT" | "BOTH"; + /** + * ServiceLevel8Choice + * @description Details about a service level. + * + * @example { + * "Cd": "SEPA" + * } + */ + ServiceLevel8Choice: { + Cd?: components["schemas"]["ExternalServiceLevel1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * SettlementInstruction15 + * @description NOTE: Unsure on description. + * + * @example { + * "SttlmMtd": "INDA", + * "PmtTpInf": { + * "InstrPrty": "NORM", + * "SvcLvl": { + * "Cd": "SEPA" + * }, + * "LclInstrm": { + * "Cd": "CH03" + * }, + * "CtgyPurp": { + * "Cd": "SUPP" + * }, + * "Cdtr": { + * "Nm": "Name", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "AdrLine": "Address", + * "Ctry": "CH" + * }, + * "Id": { + * "OrgId": { + * "AnyBIC": "BIC", + * "Othr": { + * "Id": 123, + * "SchmeNm": { + * "Cd": "IBAN", + * "Issr": "BIC" + * } + * } + * } + * }, + * "CtryOfRes": "CH", + * "CtctDtls": { + * "Nm": "Name", + * "PhneNb": 123, + * "EmailAdr": null + * } + * } + * } + * } + */ + SettlementInstruction15: { + SttlmMtd: components["schemas"]["SettlementMethod1Code"]; + PmtTpInf?: components["schemas"]["PaymentTypeInformation28"]; + }; + /** + * SettlementMethod1Code + * @description Specifies the method used to settle the credit transfer instruction. + * + * @example CLRG + * @enum {string} + */ + SettlementMethod1Code: "INDA" | "INGA" | "COVE" | "CLRG"; + /** + * StatusReason6Choice + * @description Unsure on description. + * + * @example { + * "Cd": "AGNT" + * } + */ + StatusReason6Choice: { + Cd?: components["schemas"]["ExternalStatusReason1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * StatusReasonInformation14 + * @description Unsure on description. + * + * @example { + * "Orgtr": { + * "Nm": "Name", + * "PstlAdr": { + * "AdrTp": "ADDR", + * "Dept": "Department", + * "SubDept": "SubDepartment", + * "StrtNm": "StreetName", + * "BldgNb": "BuildingNumber", + * "PstCd": "PostCode", + * "TwnNm": "TownName", + * "CtrySubDvsn": "CountrySubDivision", + * "Ctry": "Country" + * } + * }, + * "Rsn": { + * "Cd": "AGNT" + * }, + * "AddtlInf": "AdditionalInformation" + * } + */ + StatusReasonInformation14: { + Orgtr?: components["schemas"]["PartyIdentification272"]; + Rsn?: components["schemas"]["StatusReason6Choice"]; + AddtlInf?: components["schemas"]["Max105Text"]; + }; + /** + * StructuredRegulatoryReporting3 + * @description Unsure on description. + * + * @example { + * "Tp": "T1", + * "Dt": "2018-01-01", + * "Ctry": "CH", + * "Cd": "CHF", + * "Amt": { + * "Ccy": "CHF", + * "Amt": 1000 + * }, + * "Inf": 12345 + * } + */ + StructuredRegulatoryReporting3: { + Tp?: components["schemas"]["Max35Text"]; + Dt?: components["schemas"]["ISODate"]; + Ctry?: components["schemas"]["CountryCode"]; + Cd?: components["schemas"]["Max10Text"]; + Amt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + Inf?: components["schemas"]["Max35Text"]; + }; + /** + * SupplementaryData1 + * @description Additional information that can not be captured in the structured fields and/or any other specific block. + * + * @example { + * "PlcAndNm": "Additional information", + * "Envlp": { + * "Cd": "CH03", + * "Prtry": "Additional information" + * } + * } + */ + SupplementaryData1: { + PlcAndNm?: components["schemas"]["Max350Text"]; + Envlp: components["schemas"]["SupplementaryDataEnvelope1"]; + }; + /** + * SupplementaryDataEnvelope1 + * @description Unsure on description. + * + */ + SupplementaryDataEnvelope1: Record; + /** + * TaxAmount3 + * @description Information on the amount of the tax record. + * + * @example { + * "Rate": 0, + * "TaxblBaseAmt": { + * "Ccy": "EUR", + * "Amt": 0 + * }, + * "TtlAmt": { + * "Ccy": "EUR", + * "Amt": 0 + * }, + * "Dtls": { + * "Tp": "T1", + * "Ctry": "CH", + * "Cd": "CHF", + * "Amt": { + * "Ccy": "CHF", + * "Amt": 1000 + * }, + * "Inf": 12345 + * } + * } + */ + TaxAmount3: { + Rate?: components["schemas"]["PercentageRate"]; + TaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + TtlAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + Dtls?: components["schemas"]["TaxRecordDetails3"]; + }; + /** + * TaxAuthorisation1 + * @description Details of an authorised tax paying party. + * + * @example { + * "Titl": "Mr", + * "Nm": "John Doe" + * } + */ + TaxAuthorisation1: { + Titl?: components["schemas"]["Max35Text"]; + Nm?: components["schemas"]["Max140Text"]; + }; + /** + * TaxData1 + * @description Details about tax paid, or to be paid, to the government in accordance with the law, including pre-defined parameters such as thresholds and type of account. + * + * @example { + * "Cdtr": { + * "Titl": "Mr", + * "Nm": "John Doe" + * }, + * "Dbtr": { + * "Titl": "Mr", + * "Nm": "John Doe" + * }, + * "UltmtDbtr": { + * "Titl": "Mr", + * "Nm": "John Doe" + * }, + * "AdmstnZone": "CH", + * "RefNb": 12345, + * "Mtd": "A", + * "TtlTaxblBaseAmt": { + * "Ccy": "CHF", + * "Amt": 1000 + * }, + * "TtlTaxAmt": { + * "Ccy": "CHF", + * "Amt": 100 + * }, + * "Dt": "2018-01-01", + * "SeqNb": 1, + * "Rcrd": { + * "Tp": "T1", + * "Ctry": "CH", + * "Cd": "CHF", + * "Amt": { + * "Ccy": "CHF", + * "Amt": 1000 + * }, + * "Inf": 12345 + * } + * } + */ + TaxData1: { + Cdtr?: components["schemas"]["TaxParty1"]; + Dbtr?: components["schemas"]["TaxParty2"]; + UltmtDbtr?: components["schemas"]["TaxParty2"]; + AdmstnZone?: components["schemas"]["Max35Text"]; + RefNb?: components["schemas"]["Max140Text"]; + Mtd?: components["schemas"]["Max35Text"]; + TtlTaxblBaseAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + TtlTaxAmt?: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + Dt?: components["schemas"]["ISODate"]; + SeqNb?: components["schemas"]["Number"]; + Rcrd?: components["schemas"]["TaxRecord3"]; + }; + /** + * TaxParty1 + * @description Details about the entity involved in the tax paid or to be paid. + * + * @example { + * "TaxId": 123456789, + * "RegnId": 123456789, + * "TaxTp": "VAT" + * } + */ + TaxParty1: { + TaxId?: components["schemas"]["Max35Text"]; + RegnId?: components["schemas"]["Max35Text"]; + TaxTp?: components["schemas"]["Max35Text"]; + }; + /** + * TaxParty2 + * @description Details about the entity involved in the tax paid or to be paid. + * + * @example { + * "TaxId": 123456789, + * "RegnId": 123456789, + * "TaxTp": "VAT", + * "Authstn": { + * "Titl": "Mr", + * "Nm": "John Doe" + * } + * } + */ + TaxParty2: { + TaxId?: components["schemas"]["Max35Text"]; + RegnId?: components["schemas"]["Max35Text"]; + TaxTp?: components["schemas"]["Max35Text"]; + Authstn?: components["schemas"]["TaxAuthorisation1"]; + }; + /** + * TaxPeriod3 + * @description Period of time details related to the tax payment. + * + * @example { + * "Yr": 2020, + * "Tp": "MM01", + * "FrToDt": { + * "FrDt": "2020-01-01", + * "ToDt": "2020-01-31" + * } + * } + */ + TaxPeriod3: { + Yr?: components["schemas"]["ISOYear"]; + Tp?: components["schemas"]["TaxRecordPeriod1Code"]; + FrToDt?: components["schemas"]["DatePeriod2"]; + }; + /** + * TaxRecord3 + * @description Set of elements used to define the tax record. + * + * @example { + * "Tp": "VAT", + * "Ctgy": "A", + * "CtgyDtls": "Standard", + * "DbtrSts": "Resident", + * "CertId": 123456789, + * "FrmsCd": 123456789, + * "Prd": { + * "FrstDay": "2019-01-01", + * "LastDay": "2019-12-31" + * }, + * "TaxAmt": { + * "Rate": 0.2, + * "TaxblBaseAmt": 1000, + * "TtlAmt": 200 + * }, + * "AddtlInf": "VAT applicable" + * } + */ + TaxRecord3: { + Tp?: components["schemas"]["Max35Text"]; + Ctgy?: components["schemas"]["Max35Text"]; + CtgyDtls?: components["schemas"]["Max35Text"]; + DbtrSts?: components["schemas"]["Max35Text"]; + CertId?: components["schemas"]["Max35Text"]; + FrmsCd?: components["schemas"]["Max35Text"]; + Prd?: components["schemas"]["TaxPeriod3"]; + TaxAmt?: components["schemas"]["TaxAmount3"]; + AddtlInf?: components["schemas"]["Max140Text"]; + }; + /** + * TaxRecordDetails3 + * @description Details on the tax period and amount + * + * @example { + * "Prd": { + * "Yr": 2020, + * "Tp": "MM01", + * "FrToDt": { + * "FrDt": "2020-01-01", + * "ToDt": "2020-01-31" + * } + * }, + * "Amt": { + * "Amt": 100, + * "Ccy": "EUR" + * } + * } + */ + TaxRecordDetails3: { + Prd?: components["schemas"]["TaxPeriod3"]; + Amt: components["schemas"]["ActiveOrHistoricCurrencyAndAmount"]; + }; + /** + * TaxRecordPeriod1Code + * @description Specifies the period related to the tax payment + * + * MM01 FirstMonth Tax is related to the second month of the period. + * MM02 SecondMonth Tax is related to the first month of the period. + * MM03 ThirdMonth Tax is related to the third month of the period. + * MM04 FourthMonth Tax is related to the fourth month of the period. + * MM05 FifthMonth Tax is related to the fifth month of the period. + * MM06 SixthMonth Tax is related to the sixth month of the period. + * MM07 SeventhMonth Tax is related to the seventh month of the period. + * MM08 EighthMonth Tax is related to the eighth month of the period. + * MM09 NinthMonth Tax is related to the ninth month of the period. + * MM10 TenthMonth Tax is related to the tenth month of the period. + * MM11 EleventhMonth Tax is related to the eleventh month of the period. + * MM12 TwelfthMonth Tax is related to the twelfth month of the period. + * QTR1 FirstQuarter Tax is related to the first quarter of the period. + * QTR2 SecondQuarter Tax is related to the second quarter of the period. + * QTR3 ThirdQuarter Tax is related to the third quarter of the period. + * QTR4 FourthQuarter Tax is related to the forth quarter of the period. + * HLF1 FirstHalf Tax is related to the first half of the period. + * HLF2 SecondHalf Tax is related to the second half of the period. + * + * @example HLF1 + * @enum {string} + */ + TaxRecordPeriod1Code: "MM01" | "MM02" | "MM03" | "MM04" | "MM05" | "MM06" | "MM07" | "MM08" | "MM09" | "MM10" | "MM11" | "MM12" | "QTR1" | "QTR2" | "QTR3" | "QTR4" | "HLF1" | "HLF2"; + /** + * TermsRequest_FIToFICustomerCreditProposal + * @example { + * "GrpHdr": { + * "MsgId": 123456789, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "CtrlSum": 100, + * "InitgPty": { + * "Nm": "Initiating Party Name", + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BBA", + * "Prtry": "Party Identification Scheme Name" + * } + * } + * ] + * } + * } + * }, + * "FwdgAgt": { + * "FinInstnId": { + * "BICFI": "BBBBBBBB" + * } + * } + * } + * } + */ + TermsRequest_FIToFICustomerCreditProposal: { + GrpHdr: components["schemas"]["GroupHeader129"]; + }; + /** + * TermsResponse_FIToFICustomerCreditConfirmation + * @example { + * "GrpHdr": { + * "MsgId": 123456789, + * "CreDtTm": "2020-01-01T00:00:00Z", + * "NbOfTxs": 1, + * "CtrlSum": 100, + * "InitgPty": { + * "Nm": "Initiating Party Name", + * "Id": { + * "OrgId": { + * "Othr": [ + * { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "BBA", + * "Prtry": "Party Identification Scheme Name" + * } + * } + * ] + * } + * } + * }, + * "FwdgAgt": { + * "FinInstnId": { + * "BICFI": "BBBBBBBB" + * } + * } + * } + * } + */ + TermsResponse_FIToFICustomerCreditConfirmation: { + GrpHdr: components["schemas"]["GroupHeader129"]; + CdtTrfTxInf: components["schemas"]["CreditTransferTransaction67"]; + }; + /** + * UUIDv4Identifier + * @example 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e + */ + UUIDv4Identifier: string; + /** + * VerificationReason1Choice + * @example { + * "Cd": "AGNT" + * } + */ + VerificationReason1Choice: { + Cd?: components["schemas"]["ExternalVerificationReason1Code"]; + Prtry?: components["schemas"]["Max35Text"]; + } & (unknown | unknown); + /** + * VerificationReport4 + * @example { + * "OrgnlId": 123456789, + * "Vrfctn": true, + * "Rsn": { + * "Cd": "AGNT" + * }, + * "OrgnlPtyAndAcctId": { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "CCPT" + * } + * }, + * "UpdtdPtyAndAcctId": { + * "Id": 123456789, + * "SchmeNm": { + * "Cd": "CCPT" + * } + * } + * } + */ + VerificationReport4: { + OrgnlId: components["schemas"]["Max35Text"]; + Vrfctn: components["schemas"]["IdentificationVerificationIndicator"]; + Rsn?: components["schemas"]["VerificationReason1Choice"]; + OrgnlPtyAndAcctId?: components["schemas"]["IdentificationInformation4"]; + UpdtdPtyAndAcctId?: components["schemas"]["IdentificationInformation4"]; + }; + /** + * hexBinary + * @example 4660 + */ + hexBinary: string; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Method Not Allowed */ + 405: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Acceptable */ + 406: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Implemented */ + 501: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Service Unavailable */ + 503: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + }; + parameters: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: string; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: string; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination": string; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption": string; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method": string; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature": string; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": string; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI": string; + /** @description The identifier value. */ + ID: string; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: string; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For": string; + }; + requestBodies: never; + headers: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + }; + pathItems: never; +} +export type $defs = Record; +export interface operations { + PartiesByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["GetParties_IdentificationVerificationReportV03"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["GetPartiesError_IdentificationVerificationReportV03"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdByTypeAndIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Party information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["GetParties_IdentificationVerificationReportV03"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PartiesSubIdErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["GetPartiesError_IdentificationVerificationReportV03"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + Quotes: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["TermsRequest_FIToFICustomerCreditProposal"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByID1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["TermsResponse_FIToFICustomerCreditConfirmation"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + QuotesByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsError_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + transfers: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["Execute_FIToFICustomerCreditTransferV13"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsStatus_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDPatch: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer notification upon completion. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsStatus_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + TransfersByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsError_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesPost: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the FX quote to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxRequest_FICreditTransferProposal"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesByIdPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description FX Quote information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxResponse_FICreditTransferConfirmation"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxQuotesByIDAndErrorPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsError_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersPost: { + parameters: { + query?: never; + header: { + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + /** @description Details of the FX transfer to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["Fxecute_FinancialInstitutionCreditTransferV12"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDGet: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsStatus_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDPatch: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Transfer notification upon completion. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsStatus_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + FxTransfersByIDAndErrorPut: { + parameters: { + query?: never; + header: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["PacsError_FIToFIPaymentStatusReportV15"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; +} diff --git a/src/fspiop/v2_0_ISO20022/schemas.ts b/src/fspiop/v2_0_ISO20022/schemas.ts new file mode 100644 index 00000000..20a44257 --- /dev/null +++ b/src/fspiop/v2_0_ISO20022/schemas.ts @@ -0,0 +1,168 @@ +/* eslint-disable @typescript-eslint/no-namespace */ + +/** This file is generated by json-schema-generator.js program **/ + +import JsonSchemas from './json-schemas.json' + +export namespace Schemas { + export const AccountIdentification4Choice = JsonSchemas.AccountIdentification4Choice + export const AccountSchemeName1Choice = JsonSchemas.AccountSchemeName1Choice + export const ActiveCurrencyAndAmount = JsonSchemas.ActiveCurrencyAndAmount + export const ActiveCurrencyAndAmount_SimpleType = JsonSchemas.ActiveCurrencyAndAmount_SimpleType + export const ActiveCurrencyCode = JsonSchemas.ActiveCurrencyCode + export const ActiveOrHistoricCurrencyAndAmount = JsonSchemas.ActiveOrHistoricCurrencyAndAmount + export const ActiveOrHistoricCurrencyAndAmount_SimpleType = JsonSchemas.ActiveOrHistoricCurrencyAndAmount_SimpleType + export const ActiveOrHistoricCurrencyCode = JsonSchemas.ActiveOrHistoricCurrencyCode + export const AddressType2Code = JsonSchemas.AddressType2Code + export const AddressType3Choice = JsonSchemas.AddressType3Choice + export const AnyBICDec2014Identifier = JsonSchemas.AnyBICDec2014Identifier + export const BICFIDec2014Identifier = JsonSchemas.BICFIDec2014Identifier + export const BaseOneRate = JsonSchemas.BaseOneRate + export const BranchAndFinancialInstitutionIdentification6 = JsonSchemas.BranchAndFinancialInstitutionIdentification6 + export const BranchAndFinancialInstitutionIdentification8 = JsonSchemas.BranchAndFinancialInstitutionIdentification8 + export const BranchData3 = JsonSchemas.BranchData3 + export const BranchData5 = JsonSchemas.BranchData5 + export const CashAccount40 = JsonSchemas.CashAccount40 + export const CashAccountType2Choice = JsonSchemas.CashAccountType2Choice + export const CategoryPurpose1Choice = JsonSchemas.CategoryPurpose1Choice + export const ChargeBearerType1Code = JsonSchemas.ChargeBearerType1Code + export const ChargeType3Choice = JsonSchemas.ChargeType3Choice + export const Charges16 = JsonSchemas.Charges16 + export const ClearingChannel2Code = JsonSchemas.ClearingChannel2Code + export const ClearingSystemIdentification2Choice = JsonSchemas.ClearingSystemIdentification2Choice + export const ClearingSystemMemberIdentification2 = JsonSchemas.ClearingSystemMemberIdentification2 + export const Contact13 = JsonSchemas.Contact13 + export const Contact4 = JsonSchemas.Contact4 + export const CountryCode = JsonSchemas.CountryCode + export const CreditTransferTransaction67 = JsonSchemas.CreditTransferTransaction67 + export const CreditTransferTransaction68 = JsonSchemas.CreditTransferTransaction68 + export const CryptographicLockChoice = JsonSchemas.CryptographicLockChoice + export const DateAndPlaceOfBirth1 = JsonSchemas.DateAndPlaceOfBirth1 + export const DatePeriod2 = JsonSchemas.DatePeriod2 + export const ErrorCode = JsonSchemas.ErrorCode + export const ErrorDescription = JsonSchemas.ErrorDescription + export const ErrorInformation = JsonSchemas.ErrorInformation + export const ErrorInformationResponse = JsonSchemas.ErrorInformationResponse + export const Exact32HexBinaryText = JsonSchemas.Exact32HexBinaryText + export const Exact4AlphaNumericText = JsonSchemas.Exact4AlphaNumericText + export const Execute_FIToFICustomerCreditTransferV13 = JsonSchemas.Execute_FIToFICustomerCreditTransferV13 + export const Extension = JsonSchemas.Extension + export const ExtensionKey = JsonSchemas.ExtensionKey + export const ExtensionList = JsonSchemas.ExtensionList + export const ExtensionValue = JsonSchemas.ExtensionValue + export const ExternalAccountIdentification1Code = JsonSchemas.ExternalAccountIdentification1Code + export const ExternalCashAccountType1Code = JsonSchemas.ExternalCashAccountType1Code + export const ExternalCategoryPurpose1Code = JsonSchemas.ExternalCategoryPurpose1Code + export const ExternalChargeType1Code = JsonSchemas.ExternalChargeType1Code + export const ExternalClearingSystemIdentification1Code = JsonSchemas.ExternalClearingSystemIdentification1Code + export const ExternalCreditorAgentInstruction1Code = JsonSchemas.ExternalCreditorAgentInstruction1Code + export const ExternalFinancialInstitutionIdentification1Code = JsonSchemas.ExternalFinancialInstitutionIdentification1Code + export const ExternalLocalInstrument1Code = JsonSchemas.ExternalLocalInstrument1Code + export const ExternalOrganisationIdentification1Code = JsonSchemas.ExternalOrganisationIdentification1Code + export const ExternalPaymentTransactionStatus1Code = JsonSchemas.ExternalPaymentTransactionStatus1Code + export const ExternalPersonIdentification1Code = JsonSchemas.ExternalPersonIdentification1Code + export const ExternalProxyAccountType1Code = JsonSchemas.ExternalProxyAccountType1Code + export const ExternalPurpose1Code = JsonSchemas.ExternalPurpose1Code + export const ExternalServiceLevel1Code = JsonSchemas.ExternalServiceLevel1Code + export const ExternalStatusReason1Code = JsonSchemas.ExternalStatusReason1Code + export const ExternalVerificationReason1Code = JsonSchemas.ExternalVerificationReason1Code + export const FinancialIdentificationSchemeName1Choice = JsonSchemas.FinancialIdentificationSchemeName1Choice + export const FinancialInstitutionIdentification18 = JsonSchemas.FinancialInstitutionIdentification18 + export const FinancialInstitutionIdentification23 = JsonSchemas.FinancialInstitutionIdentification23 + export const FxRequest_FICreditTransferProposal = JsonSchemas.FxRequest_FICreditTransferProposal + export const FxResponse_FICreditTransferConfirmation = JsonSchemas.FxResponse_FICreditTransferConfirmation + export const Fxecute_FinancialInstitutionCreditTransferV12 = JsonSchemas.Fxecute_FinancialInstitutionCreditTransferV12 + export const GenericAccountIdentification1 = JsonSchemas.GenericAccountIdentification1 + export const GenericFinancialIdentification1 = JsonSchemas.GenericFinancialIdentification1 + export const GenericIdentification3 = JsonSchemas.GenericIdentification3 + export const GenericIdentification30 = JsonSchemas.GenericIdentification30 + export const GenericOrganisationIdentification1 = JsonSchemas.GenericOrganisationIdentification1 + export const GenericOrganisationIdentification3 = JsonSchemas.GenericOrganisationIdentification3 + export const GenericPersonIdentification1 = JsonSchemas.GenericPersonIdentification1 + export const GenericPersonIdentification2 = JsonSchemas.GenericPersonIdentification2 + export const GetPartiesError_IdentificationVerificationReportV03 = JsonSchemas.GetPartiesError_IdentificationVerificationReportV03 + export const GetParties_IdentificationVerificationReportV03 = JsonSchemas.GetParties_IdentificationVerificationReportV03 + export const GroupHeader113 = JsonSchemas.GroupHeader113 + export const GroupHeader120 = JsonSchemas.GroupHeader120 + export const GroupHeader129 = JsonSchemas.GroupHeader129 + export const IBAN2007Identifier = JsonSchemas.IBAN2007Identifier + export const ISODate = JsonSchemas.ISODate + export const ISODateTime = JsonSchemas.ISODateTime + export const ISOYear = JsonSchemas.ISOYear + export const IdentificationAssignment3 = JsonSchemas.IdentificationAssignment3 + export const IdentificationInformation4 = JsonSchemas.IdentificationInformation4 + export const IdentificationVerificationIndicator = JsonSchemas.IdentificationVerificationIndicator + export const Instruction4Code = JsonSchemas.Instruction4Code + export const InstructionForCreditorAgent3 = JsonSchemas.InstructionForCreditorAgent3 + export const InstructionForNextAgent1 = JsonSchemas.InstructionForNextAgent1 + export const LEIIdentifier = JsonSchemas.LEIIdentifier + export const LocalInstrument2Choice = JsonSchemas.LocalInstrument2Choice + export const Max105Text = JsonSchemas.Max105Text + export const Max10Text = JsonSchemas.Max10Text + export const Max128Text = JsonSchemas.Max128Text + export const Max140Text = JsonSchemas.Max140Text + export const Max15NumericText = JsonSchemas.Max15NumericText + export const Max16Text = JsonSchemas.Max16Text + export const Max2048Text = JsonSchemas.Max2048Text + export const Max256Text = JsonSchemas.Max256Text + export const Max34Text = JsonSchemas.Max34Text + export const Max350Text = JsonSchemas.Max350Text + export const Max35Text = JsonSchemas.Max35Text + export const Max4Text = JsonSchemas.Max4Text + export const Max70Text = JsonSchemas.Max70Text + export const NamePrefix2Code = JsonSchemas.NamePrefix2Code + export const Number = JsonSchemas.Number + export const OrganisationIdentification29 = JsonSchemas.OrganisationIdentification29 + export const OrganisationIdentification39 = JsonSchemas.OrganisationIdentification39 + export const OrganisationIdentificationSchemeName1Choice = JsonSchemas.OrganisationIdentificationSchemeName1Choice + export const OtherContact1 = JsonSchemas.OtherContact1 + export const PacsError_FIToFIPaymentStatusReportV15 = JsonSchemas.PacsError_FIToFIPaymentStatusReportV15 + export const PacsStatus_FIToFIPaymentStatusReportV15 = JsonSchemas.PacsStatus_FIToFIPaymentStatusReportV15 + export const Party38Choice = JsonSchemas.Party38Choice + export const Party40Choice = JsonSchemas.Party40Choice + export const Party52Choice = JsonSchemas.Party52Choice + export const PartyIdentification135 = JsonSchemas.PartyIdentification135 + export const PartyIdentification272 = JsonSchemas.PartyIdentification272 + export const PaymentIdentification13 = JsonSchemas.PaymentIdentification13 + export const PaymentTransaction163 = JsonSchemas.PaymentTransaction163 + export const PaymentTypeInformation28 = JsonSchemas.PaymentTypeInformation28 + export const PercentageRate = JsonSchemas.PercentageRate + export const PersonIdentification13 = JsonSchemas.PersonIdentification13 + export const PersonIdentification18 = JsonSchemas.PersonIdentification18 + export const PersonIdentificationSchemeName1Choice = JsonSchemas.PersonIdentificationSchemeName1Choice + export const PhoneNumber = JsonSchemas.PhoneNumber + export const PostalAddress24 = JsonSchemas.PostalAddress24 + export const PostalAddress27 = JsonSchemas.PostalAddress27 + export const PreferredContactMethod1Code = JsonSchemas.PreferredContactMethod1Code + export const PreferredContactMethod2Code = JsonSchemas.PreferredContactMethod2Code + export const Priority2Code = JsonSchemas.Priority2Code + export const ProxyAccountIdentification1 = JsonSchemas.ProxyAccountIdentification1 + export const ProxyAccountType1Choice = JsonSchemas.ProxyAccountType1Choice + export const Purpose2Choice = JsonSchemas.Purpose2Choice + export const RegulatoryAuthority2 = JsonSchemas.RegulatoryAuthority2 + export const RegulatoryReporting3 = JsonSchemas.RegulatoryReporting3 + export const RegulatoryReportingType1Code = JsonSchemas.RegulatoryReportingType1Code + export const ServiceLevel8Choice = JsonSchemas.ServiceLevel8Choice + export const SettlementInstruction15 = JsonSchemas.SettlementInstruction15 + export const SettlementMethod1Code = JsonSchemas.SettlementMethod1Code + export const StatusReason6Choice = JsonSchemas.StatusReason6Choice + export const StatusReasonInformation14 = JsonSchemas.StatusReasonInformation14 + export const StructuredRegulatoryReporting3 = JsonSchemas.StructuredRegulatoryReporting3 + export const SupplementaryData1 = JsonSchemas.SupplementaryData1 + export const SupplementaryDataEnvelope1 = JsonSchemas.SupplementaryDataEnvelope1 + export const TaxAmount3 = JsonSchemas.TaxAmount3 + export const TaxAuthorisation1 = JsonSchemas.TaxAuthorisation1 + export const TaxData1 = JsonSchemas.TaxData1 + export const TaxParty1 = JsonSchemas.TaxParty1 + export const TaxParty2 = JsonSchemas.TaxParty2 + export const TaxPeriod3 = JsonSchemas.TaxPeriod3 + export const TaxRecord3 = JsonSchemas.TaxRecord3 + export const TaxRecordDetails3 = JsonSchemas.TaxRecordDetails3 + export const TaxRecordPeriod1Code = JsonSchemas.TaxRecordPeriod1Code + export const TermsRequest_FIToFICustomerCreditProposal = JsonSchemas.TermsRequest_FIToFICustomerCreditProposal + export const TermsResponse_FIToFICustomerCreditConfirmation = JsonSchemas.TermsResponse_FIToFICustomerCreditConfirmation + export const UUIDv4Identifier = JsonSchemas.UUIDv4Identifier + export const VerificationReason1Choice = JsonSchemas.VerificationReason1Choice + export const VerificationReport4 = JsonSchemas.VerificationReport4 + export const hexBinary = JsonSchemas.hexBinary +} diff --git a/src/fspiop/v2_0_ISO20022/types.ts b/src/fspiop/v2_0_ISO20022/types.ts new file mode 100644 index 00000000..41a2c755 --- /dev/null +++ b/src/fspiop/v2_0_ISO20022/types.ts @@ -0,0 +1,168 @@ +/* eslint-disable @typescript-eslint/no-namespace */ + +/** This file is generated by json-schema-generator.js program **/ + +import { components } from './openapi' + +export namespace Types { + export type AccountIdentification4Choice = components['schemas']['AccountIdentification4Choice'] + export type AccountSchemeName1Choice = components['schemas']['AccountSchemeName1Choice'] + export type ActiveCurrencyAndAmount = components['schemas']['ActiveCurrencyAndAmount'] + export type ActiveCurrencyAndAmount_SimpleType = components['schemas']['ActiveCurrencyAndAmount_SimpleType'] + export type ActiveCurrencyCode = components['schemas']['ActiveCurrencyCode'] + export type ActiveOrHistoricCurrencyAndAmount = components['schemas']['ActiveOrHistoricCurrencyAndAmount'] + export type ActiveOrHistoricCurrencyAndAmount_SimpleType = components['schemas']['ActiveOrHistoricCurrencyAndAmount_SimpleType'] + export type ActiveOrHistoricCurrencyCode = components['schemas']['ActiveOrHistoricCurrencyCode'] + export type AddressType2Code = components['schemas']['AddressType2Code'] + export type AddressType3Choice = components['schemas']['AddressType3Choice'] + export type AnyBICDec2014Identifier = components['schemas']['AnyBICDec2014Identifier'] + export type BICFIDec2014Identifier = components['schemas']['BICFIDec2014Identifier'] + export type BaseOneRate = components['schemas']['BaseOneRate'] + export type BranchAndFinancialInstitutionIdentification6 = components['schemas']['BranchAndFinancialInstitutionIdentification6'] + export type BranchAndFinancialInstitutionIdentification8 = components['schemas']['BranchAndFinancialInstitutionIdentification8'] + export type BranchData3 = components['schemas']['BranchData3'] + export type BranchData5 = components['schemas']['BranchData5'] + export type CashAccount40 = components['schemas']['CashAccount40'] + export type CashAccountType2Choice = components['schemas']['CashAccountType2Choice'] + export type CategoryPurpose1Choice = components['schemas']['CategoryPurpose1Choice'] + export type ChargeBearerType1Code = components['schemas']['ChargeBearerType1Code'] + export type ChargeType3Choice = components['schemas']['ChargeType3Choice'] + export type Charges16 = components['schemas']['Charges16'] + export type ClearingChannel2Code = components['schemas']['ClearingChannel2Code'] + export type ClearingSystemIdentification2Choice = components['schemas']['ClearingSystemIdentification2Choice'] + export type ClearingSystemMemberIdentification2 = components['schemas']['ClearingSystemMemberIdentification2'] + export type Contact13 = components['schemas']['Contact13'] + export type Contact4 = components['schemas']['Contact4'] + export type CountryCode = components['schemas']['CountryCode'] + export type CreditTransferTransaction67 = components['schemas']['CreditTransferTransaction67'] + export type CreditTransferTransaction68 = components['schemas']['CreditTransferTransaction68'] + export type CryptographicLockChoice = components['schemas']['CryptographicLockChoice'] + export type DateAndPlaceOfBirth1 = components['schemas']['DateAndPlaceOfBirth1'] + export type DatePeriod2 = components['schemas']['DatePeriod2'] + export type ErrorCode = components['schemas']['ErrorCode'] + export type ErrorDescription = components['schemas']['ErrorDescription'] + export type ErrorInformation = components['schemas']['ErrorInformation'] + export type ErrorInformationResponse = components['schemas']['ErrorInformationResponse'] + export type Exact32HexBinaryText = components['schemas']['Exact32HexBinaryText'] + export type Exact4AlphaNumericText = components['schemas']['Exact4AlphaNumericText'] + export type Execute_FIToFICustomerCreditTransferV13 = components['schemas']['Execute_FIToFICustomerCreditTransferV13'] + export type Extension = components['schemas']['Extension'] + export type ExtensionKey = components['schemas']['ExtensionKey'] + export type ExtensionList = components['schemas']['ExtensionList'] + export type ExtensionValue = components['schemas']['ExtensionValue'] + export type ExternalAccountIdentification1Code = components['schemas']['ExternalAccountIdentification1Code'] + export type ExternalCashAccountType1Code = components['schemas']['ExternalCashAccountType1Code'] + export type ExternalCategoryPurpose1Code = components['schemas']['ExternalCategoryPurpose1Code'] + export type ExternalChargeType1Code = components['schemas']['ExternalChargeType1Code'] + export type ExternalClearingSystemIdentification1Code = components['schemas']['ExternalClearingSystemIdentification1Code'] + export type ExternalCreditorAgentInstruction1Code = components['schemas']['ExternalCreditorAgentInstruction1Code'] + export type ExternalFinancialInstitutionIdentification1Code = components['schemas']['ExternalFinancialInstitutionIdentification1Code'] + export type ExternalLocalInstrument1Code = components['schemas']['ExternalLocalInstrument1Code'] + export type ExternalOrganisationIdentification1Code = components['schemas']['ExternalOrganisationIdentification1Code'] + export type ExternalPaymentTransactionStatus1Code = components['schemas']['ExternalPaymentTransactionStatus1Code'] + export type ExternalPersonIdentification1Code = components['schemas']['ExternalPersonIdentification1Code'] + export type ExternalProxyAccountType1Code = components['schemas']['ExternalProxyAccountType1Code'] + export type ExternalPurpose1Code = components['schemas']['ExternalPurpose1Code'] + export type ExternalServiceLevel1Code = components['schemas']['ExternalServiceLevel1Code'] + export type ExternalStatusReason1Code = components['schemas']['ExternalStatusReason1Code'] + export type ExternalVerificationReason1Code = components['schemas']['ExternalVerificationReason1Code'] + export type FinancialIdentificationSchemeName1Choice = components['schemas']['FinancialIdentificationSchemeName1Choice'] + export type FinancialInstitutionIdentification18 = components['schemas']['FinancialInstitutionIdentification18'] + export type FinancialInstitutionIdentification23 = components['schemas']['FinancialInstitutionIdentification23'] + export type FxRequest_FICreditTransferProposal = components['schemas']['FxRequest_FICreditTransferProposal'] + export type FxResponse_FICreditTransferConfirmation = components['schemas']['FxResponse_FICreditTransferConfirmation'] + export type Fxecute_FinancialInstitutionCreditTransferV12 = components['schemas']['Fxecute_FinancialInstitutionCreditTransferV12'] + export type GenericAccountIdentification1 = components['schemas']['GenericAccountIdentification1'] + export type GenericFinancialIdentification1 = components['schemas']['GenericFinancialIdentification1'] + export type GenericIdentification3 = components['schemas']['GenericIdentification3'] + export type GenericIdentification30 = components['schemas']['GenericIdentification30'] + export type GenericOrganisationIdentification1 = components['schemas']['GenericOrganisationIdentification1'] + export type GenericOrganisationIdentification3 = components['schemas']['GenericOrganisationIdentification3'] + export type GenericPersonIdentification1 = components['schemas']['GenericPersonIdentification1'] + export type GenericPersonIdentification2 = components['schemas']['GenericPersonIdentification2'] + export type GetPartiesError_IdentificationVerificationReportV03 = components['schemas']['GetPartiesError_IdentificationVerificationReportV03'] + export type GetParties_IdentificationVerificationReportV03 = components['schemas']['GetParties_IdentificationVerificationReportV03'] + export type GroupHeader113 = components['schemas']['GroupHeader113'] + export type GroupHeader120 = components['schemas']['GroupHeader120'] + export type GroupHeader129 = components['schemas']['GroupHeader129'] + export type IBAN2007Identifier = components['schemas']['IBAN2007Identifier'] + export type ISODate = components['schemas']['ISODate'] + export type ISODateTime = components['schemas']['ISODateTime'] + export type ISOYear = components['schemas']['ISOYear'] + export type IdentificationAssignment3 = components['schemas']['IdentificationAssignment3'] + export type IdentificationInformation4 = components['schemas']['IdentificationInformation4'] + export type IdentificationVerificationIndicator = components['schemas']['IdentificationVerificationIndicator'] + export type Instruction4Code = components['schemas']['Instruction4Code'] + export type InstructionForCreditorAgent3 = components['schemas']['InstructionForCreditorAgent3'] + export type InstructionForNextAgent1 = components['schemas']['InstructionForNextAgent1'] + export type LEIIdentifier = components['schemas']['LEIIdentifier'] + export type LocalInstrument2Choice = components['schemas']['LocalInstrument2Choice'] + export type Max105Text = components['schemas']['Max105Text'] + export type Max10Text = components['schemas']['Max10Text'] + export type Max128Text = components['schemas']['Max128Text'] + export type Max140Text = components['schemas']['Max140Text'] + export type Max15NumericText = components['schemas']['Max15NumericText'] + export type Max16Text = components['schemas']['Max16Text'] + export type Max2048Text = components['schemas']['Max2048Text'] + export type Max256Text = components['schemas']['Max256Text'] + export type Max34Text = components['schemas']['Max34Text'] + export type Max350Text = components['schemas']['Max350Text'] + export type Max35Text = components['schemas']['Max35Text'] + export type Max4Text = components['schemas']['Max4Text'] + export type Max70Text = components['schemas']['Max70Text'] + export type NamePrefix2Code = components['schemas']['NamePrefix2Code'] + export type Number = components['schemas']['Number'] + export type OrganisationIdentification29 = components['schemas']['OrganisationIdentification29'] + export type OrganisationIdentification39 = components['schemas']['OrganisationIdentification39'] + export type OrganisationIdentificationSchemeName1Choice = components['schemas']['OrganisationIdentificationSchemeName1Choice'] + export type OtherContact1 = components['schemas']['OtherContact1'] + export type PacsError_FIToFIPaymentStatusReportV15 = components['schemas']['PacsError_FIToFIPaymentStatusReportV15'] + export type PacsStatus_FIToFIPaymentStatusReportV15 = components['schemas']['PacsStatus_FIToFIPaymentStatusReportV15'] + export type Party38Choice = components['schemas']['Party38Choice'] + export type Party40Choice = components['schemas']['Party40Choice'] + export type Party52Choice = components['schemas']['Party52Choice'] + export type PartyIdentification135 = components['schemas']['PartyIdentification135'] + export type PartyIdentification272 = components['schemas']['PartyIdentification272'] + export type PaymentIdentification13 = components['schemas']['PaymentIdentification13'] + export type PaymentTransaction163 = components['schemas']['PaymentTransaction163'] + export type PaymentTypeInformation28 = components['schemas']['PaymentTypeInformation28'] + export type PercentageRate = components['schemas']['PercentageRate'] + export type PersonIdentification13 = components['schemas']['PersonIdentification13'] + export type PersonIdentification18 = components['schemas']['PersonIdentification18'] + export type PersonIdentificationSchemeName1Choice = components['schemas']['PersonIdentificationSchemeName1Choice'] + export type PhoneNumber = components['schemas']['PhoneNumber'] + export type PostalAddress24 = components['schemas']['PostalAddress24'] + export type PostalAddress27 = components['schemas']['PostalAddress27'] + export type PreferredContactMethod1Code = components['schemas']['PreferredContactMethod1Code'] + export type PreferredContactMethod2Code = components['schemas']['PreferredContactMethod2Code'] + export type Priority2Code = components['schemas']['Priority2Code'] + export type ProxyAccountIdentification1 = components['schemas']['ProxyAccountIdentification1'] + export type ProxyAccountType1Choice = components['schemas']['ProxyAccountType1Choice'] + export type Purpose2Choice = components['schemas']['Purpose2Choice'] + export type RegulatoryAuthority2 = components['schemas']['RegulatoryAuthority2'] + export type RegulatoryReporting3 = components['schemas']['RegulatoryReporting3'] + export type RegulatoryReportingType1Code = components['schemas']['RegulatoryReportingType1Code'] + export type ServiceLevel8Choice = components['schemas']['ServiceLevel8Choice'] + export type SettlementInstruction15 = components['schemas']['SettlementInstruction15'] + export type SettlementMethod1Code = components['schemas']['SettlementMethod1Code'] + export type StatusReason6Choice = components['schemas']['StatusReason6Choice'] + export type StatusReasonInformation14 = components['schemas']['StatusReasonInformation14'] + export type StructuredRegulatoryReporting3 = components['schemas']['StructuredRegulatoryReporting3'] + export type SupplementaryData1 = components['schemas']['SupplementaryData1'] + export type SupplementaryDataEnvelope1 = components['schemas']['SupplementaryDataEnvelope1'] + export type TaxAmount3 = components['schemas']['TaxAmount3'] + export type TaxAuthorisation1 = components['schemas']['TaxAuthorisation1'] + export type TaxData1 = components['schemas']['TaxData1'] + export type TaxParty1 = components['schemas']['TaxParty1'] + export type TaxParty2 = components['schemas']['TaxParty2'] + export type TaxPeriod3 = components['schemas']['TaxPeriod3'] + export type TaxRecord3 = components['schemas']['TaxRecord3'] + export type TaxRecordDetails3 = components['schemas']['TaxRecordDetails3'] + export type TaxRecordPeriod1Code = components['schemas']['TaxRecordPeriod1Code'] + export type TermsRequest_FIToFICustomerCreditProposal = components['schemas']['TermsRequest_FIToFICustomerCreditProposal'] + export type TermsResponse_FIToFICustomerCreditConfirmation = components['schemas']['TermsResponse_FIToFICustomerCreditConfirmation'] + export type UUIDv4Identifier = components['schemas']['UUIDv4Identifier'] + export type VerificationReason1Choice = components['schemas']['VerificationReason1Choice'] + export type VerificationReport4 = components['schemas']['VerificationReport4'] + export type hexBinary = components['schemas']['hexBinary'] +} diff --git a/src/index.ts b/src/index.ts index cb4c7c33..29f4e22f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3,12 +3,14 @@ import * as v1_0 from './fspiop/v1_0' import * as v1_1 from './fspiop/v1_1' import * as v2_0 from './fspiop/v2_0' +import * as v2_0_ISO20022 from './fspiop/v2_0_ISO20022' import * as thirdparty from './thirdparty' import * as SDKSchemeAdapter from './sdk-scheme-adapter' export * as v1_0 from './fspiop/v1_0' export * as v1_1 from './fspiop/v1_1' export * as v2_0 from './fspiop/v2_0' +export * as v2_0_ISO20022 from './fspiop/v2_0_ISO20022' export * as thirdparty from './thirdparty' export * as SDKSchemeAdapter from './sdk-scheme-adapter' @@ -16,6 +18,7 @@ export default { v1_0, v1_1, v2_0, + v2_0_ISO20022, thirdparty, SDKSchemeAdapter } diff --git a/src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts b/src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts index 96be522f..bdaf454f 100644 --- a/src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts +++ b/src/sdk-scheme-adapter/v2_0_0/backend/openapi.ts @@ -3,1239 +3,1542 @@ * Do not make direct changes to the file. */ - export interface paths { - "/": { - /** Health check endpoint. */ - get: operations["BackendHealthCheck"]; - }; - "/bulkQuotes": { - /** Requests a bulk quote. */ - post: operations["BackendBulkQuotesPost"]; - }; - "/bulkQuotes/{idValue}": { - /** Requests information relating to a bulk quote identified by the specified identifier value. */ - get: operations["BackendBulkQuotesGet"]; - }; - "/bulkTransactions/{bulkTransactionId}": { - /** - * Callbacks for the bulk transaction request. - * @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. - */ - put: operations["BackendBulkTransactionsPut"]; - }; - "/requestToPay/{transactionRequestId}": { - /** - * Callback for the requestToPay request. - * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer. - */ - put: operations["RequestToPayPut"]; - }; - "/bulkTransfers": { - /** Execute bulk transfer of funds from an external account to internal accounts. */ - post: operations["BackendBulkTransfersPost"]; - }; - "/bulkTransfers/{idValue}": { - /** Requests information relating to a bulk transfer identified by the specified identifier value. */ - get: operations["BackendBulkTransfersGet"]; - }; - "/otp/{transactionRequestId}": { - /** Requests OTP. */ - get: operations["BackendOtpGet"]; - }; - "/participants/{idType}/{idValue}": { - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. - */ - get: operations["BackendParticipantsGetByTypeAndID"]; - }; - "/participants/{idType}/{idValue}/{idSubValue}": { - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. - */ - get: operations["BackendParticipantsGetByTypeIDAndSubId"]; - }; - "/parties/{idType}/{idValue}": { - /** - * Requests information relating to a transfer party identified by the specified identifier type and value. - * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. - */ - get: operations["BackendPartiesGetByTypeAndID"]; - }; - "/parties/{idType}/{idValue}/{idSubValue}": { - /** - * Requests information relating to a transfer party identified by the specified identifier type, value and subId value. - * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. - */ - get: operations["BackendPartiesGetByTypeIdAndSubId"]; - }; - "/quoterequests": { - /** - * Requests a quote for the specified transfer. - * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. - */ - post: operations["BackendQuoteRequest"]; - }; - "/transactionrequests": { - /** Transaction request that supports pull based transfers. */ - post: operations["BackendTransactionRequest"]; - }; - "/transfers": { - /** - * Transfers funds from an external account to an internal account. - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. - */ - post: operations["BackendTransfersPost"]; - }; - "/transfers/{transferId}": { - /** - * Retrieves information for a specific transfer. - * @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. - */ - get: operations["BackendTransfersGet"]; - /** - * Receive notification for a specific transfer. - * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. - */ - put: operations["BackendTransfersPut"]; - }; + "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Health check endpoint. */ + get: operations["BackendHealthCheck"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Requests a bulk quote. */ + post: operations["BackendBulkQuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Requests information relating to a bulk quote identified by the specified identifier value. */ + get: operations["BackendBulkQuotesGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransactions/{bulkTransactionId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Callbacks for the bulk transaction request. + * @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. + */ + put: operations["BackendBulkTransactionsPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPay/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Callback for the requestToPay request. + * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer. + */ + put: operations["RequestToPayPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Execute bulk transfer of funds from an external account to internal accounts. */ + post: operations["BackendBulkTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Requests information relating to a bulk transfer identified by the specified identifier value. */ + get: operations["BackendBulkTransfersGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/otp/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Requests OTP. */ + get: operations["BackendOtpGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{idType}/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. + * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. + */ + get: operations["BackendParticipantsGetByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{idType}/{idValue}/{idSubValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. + * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. + */ + get: operations["BackendParticipantsGetByTypeIDAndSubId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{idType}/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Requests information relating to a transfer party identified by the specified identifier type and value. + * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. + */ + get: operations["BackendPartiesGetByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{idType}/{idValue}/{idSubValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Requests information relating to a transfer party identified by the specified identifier type, value and subId value. + * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. + */ + get: operations["BackendPartiesGetByTypeIdAndSubId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quoterequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Requests a quote for the specified transfer. + * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. + */ + post: operations["BackendQuoteRequest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionrequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Transaction request that supports pull based transfers. */ + post: operations["BackendTransactionRequest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Transfers funds from an external account to an internal account. + * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. + */ + post: operations["BackendTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{transferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific transfer. + * @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. + */ + get: operations["BackendTransfersGet"]; + /** + * Receive notification for a specific transfer. + * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. + */ + put: operations["BackendTransfersPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** @description Data model for individual quote in a bulk quote request. */ - IndividualQuote: { - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - feesAmount?: components["schemas"]["money"]; - feesCurrency?: components["schemas"]["currency"]; - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the quote. */ - note?: string; - quoteId: components["schemas"]["quoteId"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to: components["schemas"]["transferParty"]; - transactionId: components["schemas"]["transactionId"]; - transactionType: components["schemas"]["transactionType"]; - }; - /** @description Data model for failed individual quote in a bulk quote response. */ - IndividualQuoteResultFailed: { - errorResponse: components["schemas"]["errorResponse"]; - quoteId: components["schemas"]["quoteId"]; - }; - /** @description Data model for successful individual quote in a bulk quote response. */ - IndividualQuoteResultSuccess: { - payeeFspCommissionAmount?: components["schemas"]["money"]; - payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; - payeeFspFeeAmount?: components["schemas"]["money"]; - payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; - payeeReceiveAmount?: components["schemas"]["money"]; - payeeReceiveAmountCurrency?: components["schemas"]["currency"]; - quoteId: components["schemas"]["quoteId"]; - transferAmount?: components["schemas"]["money"]; - transferAmountCurrency?: components["schemas"]["currency"]; - }; - /** @description Data model for individual transfer in a bulk transfer request. */ - IndividualTransfer: { - amount: components["schemas"]["money"]; - amountType?: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - feesAmount?: components["schemas"]["money"]; - feesCurrency?: components["schemas"]["currency"]; - initiator?: components["schemas"]["initiator"]; - initiatorType?: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the quote. */ - note?: string; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to?: components["schemas"]["transferParty"]; - transactionType?: components["schemas"]["transactionType"]; - transferId: components["schemas"]["transferId"]; - }; - /** @description Data model for individual transfer in a bulk transfer response. */ - IndividualTransferResult: { - errorResponse?: components["schemas"]["errorResponse"]; - extensionList?: components["schemas"]["extensionList"]; - transferId: components["schemas"]["transferId"]; - }; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** @description Object containing Amount and Currency of the transfer. */ - amountCurrency: { - amount: components["schemas"]["money"]; - currency: components["schemas"]["currency"]; - }; - /** @enum {string} */ - amountType: "SEND" | "RECEIVE"; - /** @description A Mojaloop API bulk quote identifier (UUID). */ - bulkQuoteId: string; - /** @description A request for a bulk quote. */ - bulkQuoteRequest: { - bulkQuoteId: components["schemas"]["bulkQuoteId"]; - expiration?: components["schemas"]["timestamp"]; - from: components["schemas"]["transferParty"]; - geoCode?: components["schemas"]["geoCode"]; - individualQuotes: components["schemas"]["IndividualQuote"][]; - }; - /** @description A response to a request for a bulk quote. */ - bulkQuoteResponse: { - bulkQuoteId: components["schemas"]["bulkQuoteId"]; - expiration?: components["schemas"]["timestamp"]; - /** @description Fees for each individual transaction, if any of them are charged per transaction. */ - individualQuoteResults: (components["schemas"]["IndividualQuoteResultSuccess"] | components["schemas"]["IndividualQuoteResultFailed"])[]; - }; - /** @description A Mojaloop API transfer identifier (UUID). */ - bulkTransferId: string; - bulkTransferRequest: { - bulkQuote?: components["schemas"]["bulkQuoteResponse"]; - bulkTransferId: components["schemas"]["bulkTransferId"]; - from?: components["schemas"]["transferParty"]; - individualTransfers: components["schemas"]["IndividualTransfer"][]; - }; - bulkTransferResponse: { - bulkTransferId?: components["schemas"]["bulkTransferId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the switch and DFSP backend systems. */ - homeTransactionId: string; - individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; - }; - /** @enum {string} */ - currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** @description Date of birth in the form YYYY-MM-DD. */ - dateOfBirth: string; - /** - * ErrorCode - * @description The API data type errorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represents the specific error. - */ - errorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - errorDescription: string; - /** - * ErrorInformation - * @description A Mojaloop API error information construct. - */ - errorInformation: { - errorCode: components["schemas"]["errorCode"]; - errorDescription: components["schemas"]["errorDescription"]; - extensionList?: components["schemas"]["extensionListComplex"]; - }; - errorResponse: { - /** @description Error message text */ - message?: string; - /** - * @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. - * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message. - */ - statusCode?: string; - }; - extensionItem: { - key?: string; - value?: string; - }; - extensionList: components["schemas"]["extensionItem"][]; - /** @description Data model for the complex type ExtensionList. */ - extensionListComplex: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["extensionItem"][]; - }; - /** @description FSP identifier. */ - fspId: string; - /** - * TransfersIDPatchResponse - * @description PUT /transfers/{transferId} object. - */ - fulfilNotification: { - currentState?: components["schemas"]["transferStatus"]; - /** @enum {string} */ - direction?: "INBOUND"; - finalNotification?: { - completedTimestamp: components["schemas"]["timestamp"]; - extensionList?: components["schemas"]["extensionList"]; - transferState: components["schemas"]["transferState"]; - }; - fulfil?: { - body?: Record; - headers?: Record; - }; - initiatedTimestamp?: components["schemas"]["timestamp"]; - lastError?: components["schemas"]["transferError"]; - prepare?: { - body?: Record; - headers?: Record; - }; - quote?: { - fulfilment?: string; - internalRequest?: Record; - mojaloopResponse?: Record; - request?: Record; - response?: Record; - }; - quoteRequest?: { - body?: Record; - headers?: Record; - }; - quoteResponse?: { - body?: Record; - headers?: Record; - }; - transferId?: components["schemas"]["transferId"]; - }; - /** @description This object may represent a number of different error object types and so its properties may vary significantly. */ - generalError: Record; - /** @description Indicates the geographic location from where the transaction was initiated. */ - geoCode: { - latitude: components["schemas"]["latitude"]; - longitude: components["schemas"]["longitude"]; - }; - idSubValue: string; - /** @enum {string} */ - idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** @description Identifier of the party. */ - idValue: string; - /** @description Object containing transfer object. */ - ilpPacketData: { - amount: components["schemas"]["amountCurrency"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - quoteId: components["schemas"]["quoteId"]; - transactionId: components["schemas"]["transactionId"]; - transactionType: components["schemas"]["transactionTypeObject"]; - }; - /** @enum {string} */ - initiator: "PAYER" | "PAYEE"; - /** @enum {string} */ - initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ - latitude: string; - /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ - longitude: string; - money: string; - otpDetails: { - /** @description OTP value. */ - otpValue: string; - }; - participantsResponse: { - fspId?: components["schemas"]["fspId"]; - }; - /** @enum {string} */ - payerType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** @description A Mojaloop API quote identifier (UUID). */ - quoteId: string; - /** @description A request for a quote for transfer from the DFSP backend. */ - quoteRequest: { - /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ - homeR2PTransactionId?: string; - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - expiration?: components["schemas"]["timestamp"]; - extensionList?: components["schemas"]["extensionList"]; - feesAmount?: components["schemas"]["money"]; - feesCurrency?: components["schemas"]["currency"]; - from: components["schemas"]["transferParty"]; - geoCode?: components["schemas"]["geoCode"]; - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the requested transfer. */ - note?: string; - quoteId: components["schemas"]["quoteId"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to: components["schemas"]["transferParty"]; - transactionId: components["schemas"]["transactionId"]; - transactionType: components["schemas"]["transactionType"]; - transactionRequestId?: components["schemas"]["transactionRequestId"]; - }; - /** @description A response to a request for a quote. */ - quoteResponse: { - expiration?: components["schemas"]["timestamp"]; - extensionList?: components["schemas"]["extensionList"]; - geoCode?: components["schemas"]["geoCode"]; - payeeFspCommissionAmount?: components["schemas"]["money"]; - payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; - payeeFspFeeAmount?: components["schemas"]["money"]; - payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; - payeeReceiveAmount?: components["schemas"]["money"]; - payeeReceiveAmountCurrency?: components["schemas"]["currency"]; - quoteId: components["schemas"]["quoteId"]; - transactionId: components["schemas"]["transactionId"]; - transferAmount: components["schemas"]["money"]; - transferAmountCurrency: components["schemas"]["currency"]; - }; - /** @enum {string} */ - scenario: "TRANSFER"; - /** @description An ISO-8601 formatted timestamp. */ - timestamp: string; - /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */ - transactionId: string; - /** @description A request for a pull based transfer. */ - transactionRequest: { - amount: components["schemas"]["money"]; - currency: components["schemas"]["currency"]; - expiration?: components["schemas"]["timestamp"]; - from: components["schemas"]["transferParty"]; - geoCode?: components["schemas"]["geoCode"]; - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the requested transfer. */ - note?: string; - to: components["schemas"]["transferParty"]; - transactionRequestId: components["schemas"]["transactionRequestId"]; - transactionType: components["schemas"]["transactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - }; - /** @description A Mojaloop API transaction request identifier (UUID). */ - transactionRequestId: string; - /** @description A response to a request for a quote. */ - transactionRequestResponse: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId?: string; - transactionId: components["schemas"]["transactionId"]; - transactionRequestState: components["schemas"]["transactionRequestState"]; - }; - /** @enum {string} */ - transactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * transactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario. - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - transactionSubScenario: string; - /** @enum {string} */ - transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT"; - /** @description Object containing transfer object. */ - transactionTypeObject: { - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - scenario: components["schemas"]["scenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - }; - transferDetailsResponse: { - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - extensions?: components["schemas"]["extensionList"]; - from: components["schemas"]["transferParty"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - note?: string; - subScenario?: components["schemas"]["TransactionSubScenario"]; - timestamp: components["schemas"]["timestamp"]; - to: components["schemas"]["transferParty"]; - transactionType: components["schemas"]["transactionType"]; - transferState: components["schemas"]["transferState"]; - }; - /** @description A Mojaloop API transfer identifier (UUID). */ - transferId: string; - transferParty: { - dateOfBirth?: components["schemas"]["dateOfBirth"]; - /** @description Display name of the sender, if known. */ - displayName?: string; - extensionList?: components["schemas"]["extensionList"]; - /** @description Party first name. */ - firstName?: string; - /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */ - fspId?: string; - idSubValue?: components["schemas"]["idSubValue"]; - idType: components["schemas"]["idType"]; - /** @description The identifier string used to identify the sender. */ - idValue: string; - /** @description Party last name. */ - lastName?: string; - /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */ - merchantClassificationCode?: string; - /** @description Party middle name. */ - middleName?: string; - type?: components["schemas"]["payerType"]; - }; - transferRequest: { - /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ - homeR2PTransactionId?: string; - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - from: components["schemas"]["transferParty"]; - ilpPacket: { - data: components["schemas"]["ilpPacketData"]; - }; - note?: string; - quote: components["schemas"]["quoteResponse"]; - quoteRequestExtensions?: components["schemas"]["extensionList"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to: components["schemas"]["transferParty"]; - transactionType: components["schemas"]["transactionType"]; - transferId: components["schemas"]["transferId"]; - transactionRequestId?: components["schemas"]["transactionRequestId"]; - }; - transferResponse: { - completedTimestamp?: components["schemas"]["timestamp"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - transferState?: components["schemas"]["transferState"]; - }; - /** - * @description Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer. - * - * @enum {string} - */ - transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** @enum {string} */ - transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; - /** @description Callback for requestToPay. */ - requestToPayCallback: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId?: string; - transactionRequestState: components["schemas"]["transactionRequestState"]; - }; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - /** @enum {string} */ - bulkTransactionStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; - autoAcceptPartyOption: { - /** @enum {boolean} */ - enabled: false | true; - }; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - bulkPerTransferFeeLimit: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - autoAcceptQuote: { - /** @enum {boolean} */ - enabled: true | false; - perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; - }; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - bulkTransactionOptions: { - /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ - onlyValidateParty?: boolean; - autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; - /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ - autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ - synchronous?: boolean; - bulkExpiration: components["schemas"]["DateTime"]; - }; - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - mojaloopError: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** @description This object represents a Mojaloop API error received at any time during the quote process */ - quoteError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - individualQuoteResult: { - quoteId: components["schemas"]["CorrelationId"]; - transferAmount?: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket?: components["schemas"]["IlpPacket"]; - condition?: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["quoteError"]; - }; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @example RESERVED - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */ - transferError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - individualTransferResult: { - transferId: components["schemas"]["CorrelationId"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - extensionList?: components["schemas"]["ExtensionList"]; - transferState?: components["schemas"]["TransferState"]; - lastError?: components["schemas"]["transferError"]; - }; - bulkTransactionIndividualTransferResult: { - transferId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - transactionId?: components["schemas"]["CorrelationId"]; - to?: components["schemas"]["Party"]; - /** @description Payer Loan reference */ - reference?: string; - amountType?: components["schemas"]["AmountType"]; - currency?: components["schemas"]["Currency"]; - amount?: components["schemas"]["Amount"]; - note?: components["schemas"]["Note"]; - quoteId?: components["schemas"]["CorrelationId"]; - quoteResponse?: components["schemas"]["individualQuoteResult"]; - fulfil?: components["schemas"]["individualTransferResult"]; - quoteExtensions?: components["schemas"]["ExtensionList"]; - transferExtensions?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["transferError"]; - }; - /** BulkTransactionResponse */ - bulkTransactionResponse: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - bulkHomeTransactionID: string; - bulkTransactionId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["bulkTransactionStatus"]; - options?: components["schemas"]["bulkTransactionOptions"]; - /** @description List of individual transfer result in a bulk transfer response. */ - individualTransferResults: components["schemas"]["bulkTransactionIndividualTransferResult"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * - U2F - U2F is a new addition isolated to Thirdparty stream. - * @example OTP - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE" | "U2F"; - }; - responses: { - /** @description Malformed or missing required headers or parameters. */ - 400: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - /** @description The party specified by the provided identifier type and value is not known to the server. */ - 404: { - content: never; + schemas: { + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** @description Data model for individual quote in a bulk quote request. */ + IndividualQuote: { + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + feesAmount?: components["schemas"]["money"]; + feesCurrency?: components["schemas"]["currency"]; + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the quote. */ + note?: string; + quoteId: components["schemas"]["quoteId"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to: components["schemas"]["transferParty"]; + transactionId: components["schemas"]["transactionId"]; + transactionType: components["schemas"]["transactionType"]; + }; + /** @description Data model for failed individual quote in a bulk quote response. */ + IndividualQuoteResultFailed: { + errorResponse: components["schemas"]["errorResponse"]; + quoteId: components["schemas"]["quoteId"]; + }; + /** @description Data model for successful individual quote in a bulk quote response. */ + IndividualQuoteResultSuccess: { + payeeFspCommissionAmount?: components["schemas"]["money"]; + payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; + payeeFspFeeAmount?: components["schemas"]["money"]; + payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; + payeeReceiveAmount?: components["schemas"]["money"]; + payeeReceiveAmountCurrency?: components["schemas"]["currency"]; + quoteId: components["schemas"]["quoteId"]; + transferAmount?: components["schemas"]["money"]; + transferAmountCurrency?: components["schemas"]["currency"]; + }; + /** @description Data model for individual transfer in a bulk transfer request. */ + IndividualTransfer: { + amount: components["schemas"]["money"]; + amountType?: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + feesAmount?: components["schemas"]["money"]; + feesCurrency?: components["schemas"]["currency"]; + initiator?: components["schemas"]["initiator"]; + initiatorType?: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the quote. */ + note?: string; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to?: components["schemas"]["transferParty"]; + transactionType?: components["schemas"]["transactionType"]; + transferId: components["schemas"]["transferId"]; + }; + /** @description Data model for individual transfer in a bulk transfer response. */ + IndividualTransferResult: { + errorResponse?: components["schemas"]["errorResponse"]; + extensionList?: components["schemas"]["extensionList"]; + transferId: components["schemas"]["transferId"]; + }; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** @description Object containing Amount and Currency of the transfer. */ + amountCurrency: { + amount: components["schemas"]["money"]; + currency: components["schemas"]["currency"]; + }; + /** @enum {string} */ + amountType: "SEND" | "RECEIVE"; + /** @description A Mojaloop API bulk quote identifier (UUID). */ + bulkQuoteId: string; + /** @description A request for a bulk quote. */ + bulkQuoteRequest: { + bulkQuoteId: components["schemas"]["bulkQuoteId"]; + expiration?: components["schemas"]["timestamp"]; + from: components["schemas"]["transferParty"]; + geoCode?: components["schemas"]["geoCode"]; + individualQuotes: components["schemas"]["IndividualQuote"][]; + }; + /** @description A response to a request for a bulk quote. */ + bulkQuoteResponse: { + bulkQuoteId: components["schemas"]["bulkQuoteId"]; + expiration?: components["schemas"]["timestamp"]; + /** @description Fees for each individual transaction, if any of them are charged per transaction. */ + individualQuoteResults: (components["schemas"]["IndividualQuoteResultSuccess"] | components["schemas"]["IndividualQuoteResultFailed"])[]; + }; + /** @description A Mojaloop API transfer identifier (UUID). */ + bulkTransferId: string; + bulkTransferRequest: { + bulkQuote?: components["schemas"]["bulkQuoteResponse"]; + bulkTransferId: components["schemas"]["bulkTransferId"]; + from?: components["schemas"]["transferParty"]; + individualTransfers: components["schemas"]["IndividualTransfer"][]; + }; + bulkTransferResponse: { + bulkTransferId?: components["schemas"]["bulkTransferId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the switch and DFSP backend systems. */ + homeTransactionId: string; + individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; + }; + /** @enum {string} */ + currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** @description Date of birth in the form YYYY-MM-DD. */ + dateOfBirth: string; + /** + * ErrorCode + * @description The API data type errorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represents the specific error. + * + */ + errorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + errorDescription: string; + /** + * ErrorInformation + * @description A Mojaloop API error information construct. + */ + errorInformation: { + errorCode: components["schemas"]["errorCode"]; + errorDescription: components["schemas"]["errorDescription"]; + extensionList?: components["schemas"]["extensionListComplex"]; + }; + errorResponse: { + /** @description Error message text */ + message?: string; + /** @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. + * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message. + * */ + statusCode?: string; + }; + extensionItem: { + key?: string; + value?: string; + }; + extensionList: components["schemas"]["extensionItem"][]; + /** @description Data model for the complex type ExtensionList. */ + extensionListComplex: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["extensionItem"][]; + }; + /** @description FSP identifier. */ + fspId: string; + /** + * TransfersIDPatchResponse + * @description PUT /transfers/{transferId} object. + */ + fulfilNotification: { + currentState?: components["schemas"]["transferStatus"]; + /** @enum {string} */ + direction?: "INBOUND"; + finalNotification?: { + completedTimestamp: components["schemas"]["timestamp"]; + extensionList?: components["schemas"]["extensionList"]; + transferState: components["schemas"]["transferState"]; + }; + fulfil?: { + body?: Record; + headers?: Record; + }; + initiatedTimestamp?: components["schemas"]["timestamp"]; + lastError?: components["schemas"]["transferError"]; + prepare?: { + body?: Record; + headers?: Record; + }; + quote?: { + fulfilment?: string; + internalRequest?: Record; + mojaloopResponse?: Record; + request?: Record; + response?: Record; + }; + quoteRequest?: { + body?: Record; + headers?: Record; + }; + quoteResponse?: { + body?: Record; + headers?: Record; + }; + transferId?: components["schemas"]["transferId"]; + }; + /** @description This object may represent a number of different error object types and so its properties may vary significantly. */ + generalError: Record; + /** @description Indicates the geographic location from where the transaction was initiated. */ + geoCode: { + latitude: components["schemas"]["latitude"]; + longitude: components["schemas"]["longitude"]; + }; + idSubValue: string; + /** @enum {string} */ + idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** @description Identifier of the party. */ + idValue: string; + /** @description Object containing transfer object. */ + ilpPacketData: { + amount: components["schemas"]["amountCurrency"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + quoteId: components["schemas"]["quoteId"]; + transactionId: components["schemas"]["transactionId"]; + transactionType: components["schemas"]["transactionTypeObject"]; + }; + /** @enum {string} */ + initiator: "PAYER" | "PAYEE"; + /** @enum {string} */ + initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ + latitude: string; + /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ + longitude: string; + money: string; + otpDetails: { + /** @description OTP value. */ + otpValue: string; + }; + participantsResponse: { + fspId?: components["schemas"]["fspId"]; + }; + /** @enum {string} */ + payerType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** @description A Mojaloop API quote identifier (UUID). */ + quoteId: string; + /** @description A request for a quote for transfer from the DFSP backend. */ + quoteRequest: { + /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ + homeR2PTransactionId?: string; + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + expiration?: components["schemas"]["timestamp"]; + extensionList?: components["schemas"]["extensionList"]; + feesAmount?: components["schemas"]["money"]; + feesCurrency?: components["schemas"]["currency"]; + from: components["schemas"]["transferParty"]; + geoCode?: components["schemas"]["geoCode"]; + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the requested transfer. */ + note?: string; + quoteId: components["schemas"]["quoteId"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to: components["schemas"]["transferParty"]; + transactionId: components["schemas"]["transactionId"]; + transactionType: components["schemas"]["transactionType"]; + transactionRequestId?: components["schemas"]["transactionRequestId"]; + }; + /** @description A response to a request for a quote. */ + quoteResponse: { + expiration?: components["schemas"]["timestamp"]; + extensionList?: components["schemas"]["extensionList"]; + geoCode?: components["schemas"]["geoCode"]; + payeeFspCommissionAmount?: components["schemas"]["money"]; + payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; + payeeFspFeeAmount?: components["schemas"]["money"]; + payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; + payeeReceiveAmount?: components["schemas"]["money"]; + payeeReceiveAmountCurrency?: components["schemas"]["currency"]; + quoteId: components["schemas"]["quoteId"]; + transactionId: components["schemas"]["transactionId"]; + transferAmount: components["schemas"]["money"]; + transferAmountCurrency: components["schemas"]["currency"]; + }; + /** @enum {string} */ + scenario: "TRANSFER"; + /** @description An ISO-8601 formatted timestamp. */ + timestamp: string; + /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */ + transactionId: string; + /** @description A request for a pull based transfer. */ + transactionRequest: { + amount: components["schemas"]["money"]; + currency: components["schemas"]["currency"]; + expiration?: components["schemas"]["timestamp"]; + from: components["schemas"]["transferParty"]; + geoCode?: components["schemas"]["geoCode"]; + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the requested transfer. */ + note?: string; + to: components["schemas"]["transferParty"]; + transactionRequestId: components["schemas"]["transactionRequestId"]; + transactionType: components["schemas"]["transactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + }; + /** @description A Mojaloop API transaction request identifier (UUID). */ + transactionRequestId: string; + /** @description A response to a request for a quote. */ + transactionRequestResponse: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId?: string; + transactionId: components["schemas"]["transactionId"]; + transactionRequestState: components["schemas"]["transactionRequestState"]; + }; + /** @enum {string} */ + transactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * transactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario. + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + transactionSubScenario: string; + /** @enum {string} */ + transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT"; + /** @description Object containing transfer object. */ + transactionTypeObject: { + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + scenario: components["schemas"]["scenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + }; + transferDetailsResponse: { + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + extensions?: components["schemas"]["extensionList"]; + from: components["schemas"]["transferParty"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + note?: string; + subScenario?: components["schemas"]["TransactionSubScenario"]; + timestamp: components["schemas"]["timestamp"]; + to: components["schemas"]["transferParty"]; + transactionType: components["schemas"]["transactionType"]; + transferState: components["schemas"]["transferState"]; + }; + /** @description A Mojaloop API transfer identifier (UUID). */ + transferId: string; + transferParty: { + dateOfBirth?: components["schemas"]["dateOfBirth"]; + /** @description Display name of the sender, if known. */ + displayName?: string; + extensionList?: components["schemas"]["extensionList"]; + /** @description Party first name. */ + firstName?: string; + /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */ + fspId?: string; + idSubValue?: components["schemas"]["idSubValue"]; + idType: components["schemas"]["idType"]; + /** @description The identifier string used to identify the sender. */ + idValue: string; + /** @description Party last name. */ + lastName?: string; + /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */ + merchantClassificationCode?: string; + /** @description Party middle name. */ + middleName?: string; + type?: components["schemas"]["payerType"]; + }; + transferRequest: { + /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ + homeR2PTransactionId?: string; + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + from: components["schemas"]["transferParty"]; + ilpPacket: { + data: components["schemas"]["ilpPacketData"]; + }; + note?: string; + quote: components["schemas"]["quoteResponse"]; + quoteRequestExtensions?: components["schemas"]["extensionList"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to: components["schemas"]["transferParty"]; + transactionType: components["schemas"]["transactionType"]; + transferId: components["schemas"]["transferId"]; + transactionRequestId?: components["schemas"]["transactionRequestId"]; + }; + transferResponse: { + completedTimestamp?: components["schemas"]["timestamp"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + transferState?: components["schemas"]["transferState"]; + }; + /** + * @description Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer. + * + * @enum {string} + */ + transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** @enum {string} */ + transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; + /** @description Callback for requestToPay. */ + requestToPayCallback: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId?: string; + transactionRequestState: components["schemas"]["transactionRequestState"]; + }; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + /** @enum {string} */ + bulkTransactionStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; + autoAcceptPartyOption: { + /** @enum {boolean} */ + enabled: false | true; + }; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + bulkPerTransferFeeLimit: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + autoAcceptQuote: { + /** @enum {boolean} */ + enabled: true | false; + perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; + }; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + bulkTransactionOptions: { + /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ + onlyValidateParty?: boolean; + autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; + /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ + autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ + synchronous?: boolean; + bulkExpiration: components["schemas"]["DateTime"]; + }; + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + mojaloopError: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** @description This object represents a Mojaloop API error received at any time during the quote process */ + quoteError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + individualQuoteResult: { + quoteId: components["schemas"]["CorrelationId"]; + transferAmount?: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket?: components["schemas"]["IlpPacket"]; + condition?: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["quoteError"]; + }; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @example RESERVED + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */ + transferError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + individualTransferResult: { + transferId: components["schemas"]["CorrelationId"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + extensionList?: components["schemas"]["ExtensionList"]; + transferState?: components["schemas"]["TransferState"]; + lastError?: components["schemas"]["transferError"]; + }; + bulkTransactionIndividualTransferResult: { + transferId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + transactionId?: components["schemas"]["CorrelationId"]; + to?: components["schemas"]["Party"]; + /** @description Payer Loan reference */ + reference?: string; + amountType?: components["schemas"]["AmountType"]; + currency?: components["schemas"]["Currency"]; + amount?: components["schemas"]["Amount"]; + note?: components["schemas"]["Note"]; + quoteId?: components["schemas"]["CorrelationId"]; + quoteResponse?: components["schemas"]["individualQuoteResult"]; + fulfil?: components["schemas"]["individualTransferResult"]; + quoteExtensions?: components["schemas"]["ExtensionList"]; + transferExtensions?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["transferError"]; + }; + /** BulkTransactionResponse */ + bulkTransactionResponse: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + bulkHomeTransactionID: string; + bulkTransactionId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["bulkTransactionStatus"]; + options?: components["schemas"]["bulkTransactionOptions"]; + /** @description List of individual transfer result in a bulk transfer response. */ + individualTransferResults: components["schemas"]["bulkTransactionIndividualTransferResult"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * - U2F - U2F is a new addition isolated to Thirdparty stream. + * @example OTP + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE" | "U2F"; }; - /** @description An error occurred processing the request. */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + responses: { + /** @description Malformed or missing required headers or parameters. */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description The party specified by the provided identifier type and value is not known to the server. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description An error occurred processing the request. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; }; - }; - parameters: { - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - idSubValue: string; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - idType: string; - /** @description The identifier value. */ - idValue: string; - transactionRequestId: components["schemas"]["transactionRequestId"]; - transferId: string; - /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ - bulkTransactionId: components["schemas"]["CorrelationId"]; - }; - requestBodies: never; - headers: never; - pathItems: never; + parameters: { + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + idSubValue: string; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: string; + /** @description The identifier value. */ + idValue: string; + transactionRequestId: components["schemas"]["transactionRequestId"]; + transferId: string; + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["schemas"]["CorrelationId"]; + }; + requestBodies: never; + headers: never; + pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - - /** Health check endpoint. */ - BackendHealthCheck: { - responses: { - /** @description Returns empty body if the service is running. */ - 200: { - content: never; - }; - }; - }; - /** Requests a bulk quote. */ - BackendBulkQuotesPost: { - /** @description Incoming request for a bulk quotation. */ - requestBody?: { - content: { - "application/json": components["schemas"]["bulkQuoteRequest"]; - }; - }; - responses: { - /** @description A response to the bulk quote request. */ - 200: { - content: { - "application/json": components["schemas"]["bulkQuoteResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** Requests information relating to a bulk quote identified by the specified identifier value. */ - BackendBulkQuotesGet: { - parameters: { - path: { - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested bulk quote. */ - 200: { - content: { - "application/json": components["schemas"]["bulkQuoteResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Callbacks for the bulk transaction request. - * @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. - */ - BackendBulkTransactionsPut: { - parameters: { - path: { - bulkTransactionId: components["parameters"]["bulkTransactionId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["bulkTransactionResponse"]; - }; - }; - responses: { - /** @description Bulk transaction information successfully amended. */ - 202: { - content: never; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Callback for the requestToPay request. - * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer. - */ - RequestToPayPut: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["requestToPayCallback"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** Execute bulk transfer of funds from an external account to internal accounts. */ - BackendBulkTransfersPost: { - /** @description An incoming bulk transfer request. */ - requestBody?: { - content: { - "application/json": components["schemas"]["bulkTransferRequest"]; - }; - }; - responses: { - /** @description The bulk transfer was accepted. */ - 200: { - content: { - "application/json": components["schemas"]["bulkTransferResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** Requests information relating to a bulk transfer identified by the specified identifier value. */ - BackendBulkTransfersGet: { - parameters: { - path: { - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested bulk transfer. */ - 200: { - content: { - "application/json": components["schemas"]["bulkTransferResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** Requests OTP. */ - BackendOtpGet: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - responses: { - /** @description Response containing details of the OTP. */ - 200: { - content: { - "application/json": components["schemas"]["otpDetails"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. - */ - BackendParticipantsGetByTypeAndID: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["participantsResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. - */ - BackendParticipantsGetByTypeIDAndSubId: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - idSubValue: components["parameters"]["idSubValue"]; - }; + BackendHealthCheck: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns empty body if the service is running. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["participantsResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; + BackendBulkQuotesPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Incoming request for a bulk quotation. */ + requestBody?: { + content: { + "application/json": components["schemas"]["bulkQuoteRequest"]; + }; + }; + responses: { + /** @description A response to the bulk quote request. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Requests information relating to a transfer party identified by the specified identifier type and value. - * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. - */ - BackendPartiesGetByTypeAndID: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - }; + BackendBulkQuotesGet: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested bulk quote. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["transferParty"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; + BackendBulkTransactionsPut: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["parameters"]["bulkTransactionId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["bulkTransactionResponse"]; + }; + }; + responses: { + /** @description Bulk transaction information successfully amended. */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Requests information relating to a transfer party identified by the specified identifier type, value and subId value. - * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. - */ - BackendPartiesGetByTypeIdAndSubId: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - idSubValue: components["parameters"]["idSubValue"]; - }; + RequestToPayPut: { + parameters: { + query?: never; + header?: never; + path: { + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["requestToPayCallback"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["transferParty"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; + BackendBulkTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description An incoming bulk transfer request. */ + requestBody?: { + content: { + "application/json": components["schemas"]["bulkTransferRequest"]; + }; + }; + responses: { + /** @description The bulk transfer was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Requests a quote for the specified transfer. - * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. - */ - BackendQuoteRequest: { - /** @description Request for a transfer quotation. */ - requestBody?: { - content: { - "application/json": components["schemas"]["quoteRequest"]; - }; + BackendBulkTransfersGet: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested bulk transfer. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description A response to the transfer quotation request. */ - 200: { - content: { - "application/json": components["schemas"]["quoteResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + BackendOtpGet: { + parameters: { + query?: never; + header?: never; + path: { + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the OTP. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["otpDetails"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - }; - /** Transaction request that supports pull based transfers. */ - BackendTransactionRequest: { - /** @description Request for Transaction Request. */ - requestBody?: { - content: { - "application/json": components["schemas"]["transactionRequest"]; - }; + BackendParticipantsGetByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["participantsResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description A response to the transfer transaction request. */ - 200: { - content: { - "application/json": components["schemas"]["transactionRequestResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + BackendParticipantsGetByTypeIDAndSubId: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + idSubValue: components["parameters"]["idSubValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["participantsResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Transfers funds from an external account to an internal account. - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. - */ - BackendTransfersPost: { - /** @description An incoming transfer request. */ - requestBody?: { - content: { - "application/json": components["schemas"]["transferRequest"]; - }; + BackendPartiesGetByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferParty"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description The transfer was accepted. */ - 200: { - content: { - "application/json": components["schemas"]["transferResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + BackendPartiesGetByTypeIdAndSubId: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + idSubValue: components["parameters"]["idSubValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferParty"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Retrieves information for a specific transfer. - * @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. - */ - BackendTransfersGet: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; + BackendQuoteRequest: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Request for a transfer quotation. */ + requestBody?: { + content: { + "application/json": components["schemas"]["quoteRequest"]; + }; + }; + responses: { + /** @description A response to the transfer quotation request. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["quoteResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description The transfer was accepted. */ - 200: { - content: { - "application/json": components["schemas"]["transferDetailsResponse"]; + BackendTransactionRequest: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Request for Transaction Request. */ + requestBody?: { + content: { + "application/json": components["schemas"]["transactionRequest"]; + }; + }; + responses: { + /** @description A response to the transfer transaction request. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transactionRequestResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; }; - }; - 500: components["responses"]["500"]; }; - }; - /** - * Receive notification for a specific transfer. - * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. - */ - BackendTransfersPut: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; + BackendTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description An incoming transfer request. */ + requestBody?: { + content: { + "application/json": components["schemas"]["transferRequest"]; + }; + }; + responses: { + /** @description The transfer was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - /** @description An incoming notification for fulfiled transfer. */ - requestBody?: { - content: { - "application/json": components["schemas"]["fulfilNotification"]; - }; + BackendTransfersGet: { + parameters: { + query?: never; + header?: never; + path: { + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The transfer was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferDetailsResponse"]; + }; + }; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description The notification was accepted. */ - 200: { - content: never; - }; - 500: components["responses"]["500"]; + BackendTransfersPut: { + parameters: { + query?: never; + header?: never; + path: { + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + /** @description An incoming notification for fulfiled transfer. */ + requestBody?: { + content: { + "application/json": components["schemas"]["fulfilNotification"]; + }; + }; + responses: { + /** @description The notification was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["500"]; + }; }; - }; } diff --git a/src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts b/src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts index 3f70a371..77928bab 100644 --- a/src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts +++ b/src/sdk-scheme-adapter/v2_0_0/outbound/openapi.ts @@ -3,1613 +3,2040 @@ * Do not make direct changes to the file. */ - export interface paths { - "/": { - /** - * Health check endpoint - * @description This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening. - */ - get: { - responses: { - /** @description Returns empty body if the scheme adapter outbound transfers service is running. */ - 200: { - content: never; - }; - }; - }; - }; - "/accounts": { - /** - * Create accounts on the Account Lookup Service - * @description The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities. - * - * Caller DFSP is used as the account source FSP information - */ - post: { - /** @description Identities list request body */ - requestBody: { - content: { - "application/json": components["schemas"]["accountsRequest"]; - }; - }; - responses: { - 200: components["responses"]["accountsCreationCompleted"]; - 400: components["responses"]["accountsCreationError"]; - 500: components["responses"]["accountsCreationError"]; - 504: components["responses"]["accountsCreationTimeout"]; - }; - }; - }; - "/bulkQuotes": { - /** - * Request bulk quotes for the provided financial transactions - * @description The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP. - */ - post: { - /** @description Bulk quote request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkQuoteRequest"]; - }; - }; - responses: { - 200: components["responses"]["bulkQuoteSuccess"]; - 400: components["responses"]["bulkQuoteBadRequest"]; - 500: components["responses"]["bulkQuoteServerError"]; - 504: components["responses"]["bulkQuoteTimeout"]; - }; - }; - }; - "/bulkQuotes/{bulkQuoteId}": { - /** - * Retrieves information for a specific bulk quote - * @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. - */ - get: { - parameters: { - path: { - bulkQuoteId: components["parameters"]["bulkQuoteId"]; - }; - }; - responses: { - /** @description Bulk quote information successfully retrieved */ - 200: { - content: { - "application/json": components["schemas"]["bulkQuoteStatusResponse"]; - }; + "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description An error occurred processing the bulk quote */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + /** + * Health check endpoint + * @description This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening. + */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns empty body if the scheme adapter outbound transfers service is running. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; }; - }; - }; - }; - "/bulkTransactions": { - /** - * Sends money from one account to multiple accounts - * @description The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP. - */ - post: { - /** @description Bulk transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkTransactionRequest"]; - }; - }; - responses: { - 202: components["responses"]["bulkTransactionAccepted"]; - 400: components["responses"]["bulkTransferBadRequest"]; - 500: components["responses"]["errorResponse"]; - }; - }; - }; - "/bulkTransactions/{bulkTransactionId}": { - /** - * Amends the bulk transaction request - * @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. - */ - put: { - parameters: { - path: { - bulkTransactionId: components["parameters"]["bulkTransactionId"]; - }; - }; - /** @description Bulk transaction request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkTransactionContinuationAcceptParty"] | components["schemas"]["bulkTransactionContinuationAcceptQuote"]; - }; - }; - responses: { - /** @description Bulk transaction information successfully amended */ - 202: { - content: never; - }; - 400: components["responses"]["bulkTransactionPutBadRequest"]; - /** @description An error occurred processing the bulk transaction */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - }; - }; - }; - "/bulkTransfers": { - /** - * Sends money from one account to multiple accounts - * @description The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP. - */ - post: { - /** @description Bulk transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkTransferRequest"]; - }; - }; - responses: { - 200: components["responses"]["bulkTransferSuccess"]; - 400: components["responses"]["bulkTransferBadRequest"]; - 500: components["responses"]["errorResponse"]; - }; - }; - }; - "/bulkTransfers/{bulkTransferId}": { - /** - * Retrieves information for a specific bulk transfer - * @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. - */ - get: { - parameters: { - path: { - bulkTransferId: components["parameters"]["bulkTransferId"]; - }; - }; - responses: { - /** @description Bulk transfer information successfully retrieved */ - 200: { - content: { - "application/json": components["schemas"]["bulkTransferStatusResponse"]; - }; - }; - /** @description An error occurred processing the bulk transfer */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - }; - }; - }; - "/parties/{Type}/{ID}": { - /** - * PartiesByTypeAndID - * @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). - */ - get: operations["PartiesByTypeAndID"]; - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/parties/{Type}/{ID}/{SubId}": { - /** - * PartiesSubIdByTypeAndID - * @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). - */ - get: operations["PartiesSubIdByTypeAndID"]; - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/quotes": { - /** - * Quotes endpoint - * @description is used to request quotes from other DFSP - */ - post: operations["QuotesPost"]; - }; - "/requestToPay": { - /** - * Receiver requesting funds from Sender - * @description The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender. - * The underlying API has two stages: - * - * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. - * 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee. - */ - post: { - /** @description RequestToPay request body */ - requestBody: { - content: { - "application/json": components["schemas"]["requestToPayRequest"]; - }; - }; - responses: { - 200: components["responses"]["requestToPaySuccess"]; - }; - }; - }; - "/requestToPay/{transactionRequestId}": { - /** - * Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information - * @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. - * The request body should contain the "acceptParty" property set to `true` as required to continue the transfer. - * See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer. - */ - put: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["transferContinuationAcceptParty"]; - }; - }; - responses: { - 200: components["responses"]["requestToPaySuccess"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/requestToPayTransfer": { - /** - * Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay. - * @description The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP. - * The underlying Mojaloop API has three stages for money transfer: - * - * 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. - * 2. Authorization. This facilitates getting OTP from payee DFSP. - * 3. Transfer. The enactment of the previously agreed "contract" - * - * This method has several modes of operation. - * - 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. - * 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. - * The scheme adapter will then proceed with the transfer state. - * - * - 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. - * 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. - * The scheme adapter will then proceed with the transfer state. - * - * 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. - * - * 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... - */ - post: { - /** @description Request To Pay Transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["requestToPayTransferRequest"]; - }; - }; - responses: { - 200: components["responses"]["requestToPayTransferSuccess"]; - 400: components["responses"]["requestToPayTransferBadRequest"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/requestToPayTransfer/{transactionRequestId}": { - /** - * Continues a transfer that has paused at the otp stage in order to accept or reject quote - * @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. - * - * The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer. - * - * See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer. - */ - put: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptOTP"]; - }; - }; - responses: { - 200: components["responses"]["transferSuccess"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/simpleTransfers": { - /** - * Simple Transfers endpoint - * @description is used to request a transfer - */ - post: operations["SimpleTransfersPost"]; - }; - "/transfers": { - /** - * Sends money from one account to another - * @description The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP. - * The underlying Mojaloop API has three stages for money transfer: - * - * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. - * 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. - * 3. Transfer. The enactment of the previously agreed "contract" - * - * This method has several modes of operation. - * - 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. - * 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. - * The scheme adapter will then proceed with quotation stage... - * - * - 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. - * 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. - * The scheme adapter will then proceed with the transfer state. - * - * 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. - * - * 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... - */ - post: { - /** @description Transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["transferRequest"]; - }; - }; - responses: { - 200: components["responses"]["transferSuccess"]; - 400: components["responses"]["transferBadRequest"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/transfers/{transferId}": { - /** - * Retrieves information for a specific transfer - * @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. - */ - get: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; - }; - responses: { - /** @description Transfer information successfully retrieved */ - 200: { - content: { - "application/json": components["schemas"]["transferStatusResponse"]; - }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description An error occurred processing the transfer */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + get?: never; + put?: never; + /** + * Create accounts on the Account Lookup Service + * @description The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities. + * + * Caller DFSP is used as the account source FSP information + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Identities list request body */ + requestBody: { + content: { + "application/json": components["schemas"]["accountsRequest"]; + }; + }; + responses: { + 200: components["responses"]["accountsCreationCompleted"]; + 400: components["responses"]["accountsCreationError"]; + 500: components["responses"]["accountsCreationError"]; + 504: components["responses"]["accountsCreationTimeout"]; + }; }; - }; - }; - /** - * Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote - * @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. - * - * The request body should contain either the "acceptParty" or "acceptQuote" property set to `true` as required to continue the transfer. - * - * See the description of the `POST /transfers` HTTP method for more information on modes of transfer. - */ - put: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["transferContinuationAcceptParty"] | components["schemas"]["transferContinuationAcceptQuote"]; - }; - }; - responses: { - 200: components["responses"]["transferSuccess"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Request bulk quotes for the provided financial transactions + * @description The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Bulk quote request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkQuoteRequest"]; + }; + }; + responses: { + 200: components["responses"]["bulkQuoteSuccess"]; + 400: components["responses"]["bulkQuoteBadRequest"]; + 500: components["responses"]["bulkQuoteServerError"]; + 504: components["responses"]["bulkQuoteTimeout"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{bulkQuoteId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific bulk quote + * @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. + */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkQuoteId: components["parameters"]["bulkQuoteId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Bulk quote information successfully retrieved */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteStatusResponse"]; + }; + }; + /** @description An error occurred processing the bulk quote */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Sends money from one account to multiple accounts + * @description The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Bulk transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkTransactionRequest"]; + }; + }; + responses: { + 202: components["responses"]["bulkTransactionAccepted"]; + 400: components["responses"]["bulkTransferBadRequest"]; + 500: components["responses"]["errorResponse"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransactions/{bulkTransactionId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Amends the bulk transaction request + * @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. + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["parameters"]["bulkTransactionId"]; + }; + cookie?: never; + }; + /** @description Bulk transaction request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkTransactionContinuationAcceptParty"] | components["schemas"]["bulkTransactionContinuationAcceptQuote"]; + }; + }; + responses: { + /** @description Bulk transaction information successfully amended */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bulkTransactionPutBadRequest"]; + /** @description An error occurred processing the bulk transaction */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Sends money from one account to multiple accounts + * @description The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Bulk transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkTransferRequest"]; + }; + }; + responses: { + 200: components["responses"]["bulkTransferSuccess"]; + 400: components["responses"]["bulkTransferBadRequest"]; + 500: components["responses"]["errorResponse"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{bulkTransferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific bulk transfer + * @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. + */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkTransferId: components["parameters"]["bulkTransferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Bulk transfer information successfully retrieved */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferStatusResponse"]; + }; + }; + /** @description An error occurred processing the bulk transfer */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * PartiesByTypeAndID + * @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). + */ + get: operations["PartiesByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * PartiesSubIdByTypeAndID + * @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). + */ + get: operations["PartiesSubIdByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Quotes endpoint + * @description is used to request quotes from other DFSP + */ + post: operations["QuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPay": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Receiver requesting funds from Sender + * @description The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender. + * The underlying API has two stages: + * + * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. + * 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description RequestToPay request body */ + requestBody: { + content: { + "application/json": components["schemas"]["requestToPayRequest"]; + }; + }; + responses: { + 200: components["responses"]["requestToPaySuccess"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPay/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information + * @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. + * The request body should contain the "acceptParty" property set to `true` as required to continue the transfer. + * See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer. + * + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["transferContinuationAcceptParty"]; + }; + }; + responses: { + 200: components["responses"]["requestToPaySuccess"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPayTransfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay. + * @description The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP. + * The underlying Mojaloop API has three stages for money transfer: + * + * 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. + * 2. Authorization. This facilitates getting OTP from payee DFSP. + * 3. Transfer. The enactment of the previously agreed "contract" + * + * This method has several modes of operation. + * - 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. + * 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. + * The scheme adapter will then proceed with the transfer state. + * + * - 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. + * 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. + * The scheme adapter will then proceed with the transfer state. + * + * 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. + * + * 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... + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Request To Pay Transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["requestToPayTransferRequest"]; + }; + }; + responses: { + 200: components["responses"]["requestToPayTransferSuccess"]; + 400: components["responses"]["requestToPayTransferBadRequest"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPayTransfer/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Continues a transfer that has paused at the otp stage in order to accept or reject quote + * @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. + * + * The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer. + * + * See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer. + * + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptOTP"]; + }; + }; + responses: { + 200: components["responses"]["transferSuccess"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/simpleTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Simple Transfers endpoint + * @description is used to request a transfer + */ + post: operations["SimpleTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Sends money from one account to another + * @description The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP. + * The underlying Mojaloop API has three stages for money transfer: + * + * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. + * 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. + * 3. Transfer. The enactment of the previously agreed "contract" + * + * This method has several modes of operation. + * - 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. + * 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. + * The scheme adapter will then proceed with quotation stage... + * + * - 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. + * 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. + * The scheme adapter will then proceed with the transfer state. + * + * 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. + * + * 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... + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["transferRequest"]; + }; + }; + responses: { + 200: components["responses"]["transferSuccess"]; + 400: components["responses"]["transferBadRequest"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{transferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific transfer + * @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. + */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Transfer information successfully retrieved */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferStatusResponse"]; + }; + }; + /** @description An error occurred processing the transfer */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + /** + * Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote + * @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. + * + * The request body should contain either the "acceptParty" or "acceptQuote" property set to `true` as required to continue the transfer. + * + * See the description of the `POST /transfers` HTTP method for more information on modes of transfer. + * + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["transferContinuationAcceptParty"] | components["schemas"]["transferContinuationAcceptQuote"]; + }; + }; + responses: { + 200: components["responses"]["transferSuccess"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - accountsRequest: { - idType: components["schemas"]["PartyIdType"]; - idValue: components["schemas"]["PartyIdentifier"]; - idSubValue?: components["schemas"]["PartySubIdOrType"]; - currency: components["schemas"]["Currency"]; - }[]; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - errorResponse: { - /** @description Error code as string. */ - statusCode?: string; - /** @description Error message text. */ - message?: string; - }; - accountCreationStatus: { - idType: components["schemas"]["PartyIdType"]; - idValue: components["schemas"]["PartyIdentifier"]; - idSubValue?: components["schemas"]["PartySubIdOrType"]; - error?: components["schemas"]["errorResponse"]; - }[]; - /** @enum {string} */ - accountsCreationState: "ERROR_OCCURRED" | "COMPLETED"; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - mojaloopError: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */ - transferError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - accountsResponse: { - modelId?: components["schemas"]["CorrelationId"]; - accounts: components["schemas"]["accountsRequest"]; - response?: components["schemas"]["accountCreationStatus"]; - currentState?: components["schemas"]["accountsCreationState"]; - lastError?: components["schemas"]["transferError"]; - postAccountsResponse?: { - body: Record; - headers?: Record; - }; - }; - errorAccountsResponse: components["schemas"]["errorResponse"] & { - executionState: components["schemas"]["accountsResponse"]; - }; - /** - * TransactionInitiatorType - * @description Below are the allowed values for the enumeration. - * - CONSUMER - Consumer is the initiator of the transaction. - * - AGENT - Agent is the initiator of the transaction. - * - BUSINESS - Business is the initiator of the transaction. - * - DEVICE - Device is the initiator of the transaction. - * @example CONSUMER - * @enum {string} - */ - TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** - * Name - * @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. - * - * 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 ( ). - * - * **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. - */ - Name: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - extensionListEmptiable: components["schemas"]["Extension"][]; - transferParty: { - type?: components["schemas"]["TransactionInitiatorType"]; - idType: components["schemas"]["PartyIdType"]; - idValue: components["schemas"]["PartyIdentifier"]; - idSubValue?: components["schemas"]["PartySubIdOrType"]; - displayName?: components["schemas"]["Name"]; - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["extensionListEmptiable"]; - }; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - /** - * transferTransactionType - * @description Type of transaction. - * @enum {string} - */ - transferTransactionType: "TRANSFER"; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * IndividualQuote - * @description Data model for the complex type 'individualQuote'. - */ - individualQuote: { - quoteId: components["schemas"]["CorrelationId"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - note?: components["schemas"]["Note"]; - extensions?: components["schemas"]["ExtensionList"]; - }; - bulkQuoteRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - bulkQuoteId?: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - /** @description List of individual quotes in a bulk quote. */ - individualQuotes: components["schemas"]["individualQuote"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - /** @enum {string} */ - bulkTransferStatus: "ERROR_OCCURRED" | "COMPLETED"; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** @description This object represents a Mojaloop API error received at any time during the quote process */ - quoteError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - individualQuoteResult: { - quoteId: components["schemas"]["CorrelationId"]; - transferAmount?: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket?: components["schemas"]["IlpPacket"]; - condition?: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["quoteError"]; - }; - bulkQuoteResponse: { - bulkQuoteId: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId?: string; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - currentState: components["schemas"]["bulkTransferStatus"]; - /** @description List of individualQuoteResults in a bulk transfer response. */ - individualQuoteResults: components["schemas"]["individualQuoteResult"][]; - }; - bulkQuoteErrorResponse: components["schemas"]["errorResponse"] & { - bulkQuoteState: components["schemas"]["bulkQuoteResponse"]; - }; - /** @enum {string} */ - bulkQuoteStatus: "ERROR_OCCURRED" | "COMPLETED"; - bulkQuoteStatusResponse: { - bulkQuoteId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["bulkQuoteStatus"]; - individualQuotes: components["schemas"]["individualQuote"][]; - }; - autoAcceptPartyOption: { - /** @enum {boolean} */ - enabled: false | true; - }; - bulkPerTransferFeeLimit: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - autoAcceptQuote: { - /** @enum {boolean} */ - enabled: true | false; - perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; - }; - bulkTransactionOptions: { - /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ - onlyValidateParty?: boolean; - autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; - /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ - autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ - synchronous?: boolean; - bulkExpiration: components["schemas"]["DateTime"]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** - * BulkTransactionIndividualTransfer - * @description Data model for the complex type 'bulkTransactionIndividualTransfer'. - */ - bulkTransactionIndividualTransfer: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - to: components["schemas"]["Party"]; - /** @description Payer Loan reference */ - reference?: string; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - note?: components["schemas"]["Note"]; - quoteExtensions?: components["schemas"]["ExtensionList"]; - transferExtensions?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["transferError"]; - }; - bulkTransactionRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - bulkHomeTransactionID: string; - bulkTransactionId: components["schemas"]["CorrelationId"]; - options: components["schemas"]["bulkTransactionOptions"]; - from: components["schemas"]["Party"]; - /** @description List of individual transfers in a bulk transfer. */ - individualTransfers: components["schemas"]["bulkTransactionIndividualTransfer"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @example RESERVED - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - individualTransferResult: { - transferId: components["schemas"]["CorrelationId"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - extensionList?: components["schemas"]["ExtensionList"]; - transferState?: components["schemas"]["TransferState"]; - lastError?: components["schemas"]["transferError"]; - }; - bulkTransferResponse: { - bulkTransferId: components["schemas"]["CorrelationId"]; - bulkQuoteId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId?: string; - bulkTransferState?: components["schemas"]["TransferState"]; - completedTimestamp?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - currentState: components["schemas"]["bulkTransferStatus"]; - /** @description List of individual transfer result in a bulk transfer response. */ - individualTransferResults: components["schemas"]["individualTransferResult"][]; - }; - bulkTransferErrorResponse: components["schemas"]["errorResponse"] & { - bulkTransferState: components["schemas"]["bulkTransferResponse"]; - }; - /** @description Data model for the 'individualTransfer' while accepting party or quote. */ - bulkTransactionIndividualTransferAccept: { - transferId: components["schemas"]["CorrelationId"]; - }; - transferContinuationAcceptParty: { - /** @enum {boolean} */ - acceptParty: true | false; - }; - /** @description The object sent back as confirmation of payee parties when autoAcceptParty is false. */ - bulkTransactionContinuationAcceptParty: { - /** @description List of individual transfers in a bulk transfer with accept party information. */ - individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptParty"])[]; - }; - transferContinuationAcceptQuote: { - /** @enum {boolean} */ - acceptQuote: true | false; - }; - /** @description The object sent back as confirmation of quotes when autoAcceptQuotes is false. */ - bulkTransactionContinuationAcceptQuote: { - /** @description List of individual transfers in a bulk transfer. */ - individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptQuote"])[]; - }; - /** @description This object represents a Mojaloop API error received at any time during the party discovery process */ - partyError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & ({ - bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"]; - }); - bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & ({ - bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"]; - }); - /** - * IndividualTransfer - * @description Data model for the complex type 'individualTransfer'. - */ - individualTransfer: { - transferId: components["schemas"]["CorrelationId"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType?: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - note?: components["schemas"]["Note"]; - extensions?: components["schemas"]["ExtensionList"]; - }; - bulkTransferRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - bulkTransferId: components["schemas"]["CorrelationId"]; - bulkQuoteId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - /** @description List of individual transfers in a bulk transfer. */ - individualTransfers: components["schemas"]["individualTransfer"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** @description A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer */ - individualTransferFulfilment: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - bulkTransferStatusResponse: { - bulkTransferId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["bulkTransferStatus"]; - fulfils: components["schemas"]["individualTransferFulfilment"][]; - }; - /** @enum {string} */ - async2SyncCurrentState: "WAITING_FOR_ACTION" | "COMPLETED" | "ERROR_OCCURRED"; - /** - * partiesByIdResponse - * @description GET /parties/{Type}/{ID} response object - */ - partiesByIdResponse: { - party: { - body: components["schemas"]["Party"]; - headers: Record; - }; - currentState: components["schemas"]["async2SyncCurrentState"]; - }; - /** - * TransactionScenario - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. - * - 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. - * - REFUND - Used for performing a refund of transaction. - * @example DEPOSIT - * @enum {string} - */ - TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; - /** - * TransactionInitiator - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * @example PAYEE - * @enum {string} - */ - TransactionInitiator: "PAYER" | "PAYEE"; - /** - * RefundReason - * @description Reason for the refund. - * @example Free text indicating reason for the refund. - */ - RefundReason: string; - /** - * Refund - * @description Data model for the complex type Refund. - */ - Refund: { - originalTransactionId: components["schemas"]["CorrelationId"]; - refundReason?: components["schemas"]["RefundReason"]; - }; - /** - * BalanceOfPayments - * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. - * @example 123 - */ - BalanceOfPayments: string; - /** - * TransactionType - * @description Data model for the complex type TransactionType. - */ - TransactionType: { - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - refundInfo?: components["schemas"]["Refund"]; - balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; - }; - /** - * QuotesPostRequest - * @description The object sent in the POST /quotes request. - */ - QuotesPostRequest: { - quoteId: components["schemas"]["CorrelationId"]; - transactionId: components["schemas"]["CorrelationId"]; - transactionRequestId?: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - amountType: components["schemas"]["AmountType"]; - amount: components["schemas"]["Money"]; - fees?: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - geoCode?: components["schemas"]["GeoCode"]; - note?: components["schemas"]["Note"]; - expiration?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** simpleQuotesPostRequest */ - simpleQuotesPostRequest: { - fspId: components["schemas"]["FspId"]; - quotesPostRequest: components["schemas"]["QuotesPostRequest"]; - }; - /** QuotesPostResponse */ - quotesPostResponse: { - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - quotes: { - body: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - /** - * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - headers: Record; - }; - currentState: components["schemas"]["async2SyncCurrentState"]; - }; - errorQuotesResponse: components["schemas"]["errorResponse"] & Record; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * - U2F - U2F is a new addition isolated to Thirdparty stream. - * @example OTP - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE" | "U2F"; - requestToPayRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId: string; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - }; - /** @enum {string} */ - requestToPayStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "COMPLETED"; - /** - * getPartiesResponse - * @description The object sent in the GET /parties/{Type}/{ID} callback. - */ - getPartiesResponse: { - body: components["schemas"]["Party"]; - headers: Record; - }; - /** - * TransactionRequestState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. - * - PENDING - Payer FSP has sent the transaction request to the Payer. - * - ACCEPTED - Payer has approved the transaction. - * - REJECTED - Payer has rejected the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * TransactionRequestResponse - * @description The object sent in the PUT /transactionRequests/{ID} callback. - */ - TransactionRequestResponse: { - body: { - transactionId?: components["schemas"]["CorrelationId"]; - transactionRequestState: components["schemas"]["TransactionRequestState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - headers: Record; - }; - requestToPayResponse: { - transactionRequestId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - currentState: components["schemas"]["requestToPayStatus"]; - getPartiesResponse?: components["schemas"]["getPartiesResponse"]; - transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"]; - lastError?: components["schemas"]["transferError"]; - }; - /** @enum {string} */ - transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - QuotesIDPutResponse: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - expiration: components["schemas"]["DateTime"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransfersIDPutResponse - * @description The object sent in the PUT /transfers/{ID} callback. - */ - TransfersIDPutResponse: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - completedTimestamp?: components["schemas"]["DateTime"]; - transferState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - transferResponse: { - transferId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - note?: components["schemas"]["Note"]; - currentState?: components["schemas"]["transferStatus"]; - quoteId?: components["schemas"]["CorrelationId"]; - getPartiesResponse?: { - body: Record; - headers?: Record; - }; - quoteResponse?: { - body: components["schemas"]["QuotesIDPutResponse"]; - headers?: Record; - }; - /** @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. */ - quoteResponseSource?: string; - fulfil?: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers?: Record; - }; - lastError?: components["schemas"]["transferError"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - }; - errorTransferResponse: components["schemas"]["errorResponse"] & { - transferState: components["schemas"]["transferResponse"]; - }; - requestToPayTransferRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId: string; - transactionRequestId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - note?: components["schemas"]["Note"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - }; - /** - * AuthenticationValue - * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. - */ - AuthenticationValue: string | { - /** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. */ - pinValue: string; - /** - * Integer - * @description Sequential counter used for cloning detection. Present only for U2F authentication. - */ - counter: string; - }; - /** - * AuthenticationInfo - * @description Data model for the complex type AuthenticationInfo. - */ - AuthenticationInfo: { - authentication: components["schemas"]["AuthenticationType"]; - authenticationValue: components["schemas"]["AuthenticationValue"]; - }; - /** - * AuthorizationResponseType - * @description Below are the allowed values for the enumeration. - * - ENTERED - Consumer entered the authentication value. - * - REJECTED - Consumer rejected the transaction. - * - RESEND - Consumer requested to resend the authentication value. - * @example ENTERED - * @enum {string} - */ - AuthorizationResponseType: "ENTERED" | "REJECTED" | "RESEND"; - /** - * AuthorizationIDPutResponse - * @description The object sent in the PUT /authorizations/{ID} callback. - */ - AuthorizationIDPutResponse: { - authenticationInfo?: components["schemas"]["AuthenticationInfo"]; - responseType: components["schemas"]["AuthorizationResponseType"]; - }; - requestToPayTransferResponse: { - transferId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId?: string; - transactionRequestId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - note?: components["schemas"]["Note"]; - currentState?: components["schemas"]["transferStatus"]; - quoteId?: components["schemas"]["CorrelationId"]; - quoteResponse?: { - body: components["schemas"]["QuotesIDPutResponse"]; - headers?: Record; - }; - /** @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. */ - quoteResponseSource?: string; - authorizationResponse?: { - body: components["schemas"]["AuthorizationIDPutResponse"]; - headers?: Record; - }; - fulfil?: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers?: Record; - }; - lastError?: components["schemas"]["transferError"]; - }; - transferContinuationAcceptOTP: { - /** @enum {boolean} */ - acceptOTP: true | false; - }; - /** - * TransfersPostRequest - * @description The object sent in the POST /transfers request. - */ - TransfersPostRequest: { - transferId: components["schemas"]["CorrelationId"]; - payeeFsp: components["schemas"]["FspId"]; - payerFsp: components["schemas"]["FspId"]; - amount: components["schemas"]["Money"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** SimpleTransfersPostRequest */ - simpleTransfersPostRequest: { - fspId: components["schemas"]["FspId"]; - transfersPostRequest: components["schemas"]["TransfersPostRequest"]; - }; - /** SimpleTransfersPostResponse */ - simpleTransfersPostResponse: { - transfer: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers: Record; - }; - currentState: components["schemas"]["async2SyncCurrentState"]; - }; - errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & Record; - transferRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - note?: components["schemas"]["Note"]; - quoteRequestExtensions?: components["schemas"]["extensionListEmptiable"]; - transferRequestExtensions?: components["schemas"]["extensionListEmptiable"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - }; - transferStatusResponse: { - transferId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["transferStatus"]; - fulfil: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers?: Record; - }; - }; - }; - responses: { - /** @description Accounts creation completed */ - accountsCreationCompleted: { - content: { - "application/json": components["schemas"]["accountsResponse"]; - }; - }; - /** @description An error occurred creating accounts */ - accountsCreationError: { - content: { - "application/json": components["schemas"]["errorAccountsResponse"]; - }; - }; - /** @description Timeout occurred creating accounts */ - accountsCreationTimeout: { - content: { - "application/json": components["schemas"]["errorAccountsResponse"]; - }; - }; - /** @description Bulk quote completed successfully */ - bulkQuoteSuccess: { - content: { - "application/json": components["schemas"]["bulkQuoteResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - bulkQuoteBadRequest: { - content: { - "application/json": components["schemas"]["bulkQuoteErrorResponse"]; - }; - }; - /** @description An error occurred processing the bulk quote */ - bulkQuoteServerError: { - content: { - "application/json": components["schemas"]["bulkQuoteErrorResponse"]; - }; - }; - /** @description Timeout occurred processing the bulk quote */ - bulkQuoteTimeout: { - content: { - "application/json": components["schemas"]["bulkQuoteErrorResponse"]; - }; - }; - /** @description Bulk transfer accepted successfully */ - bulkTransactionAccepted: { - content: never; - }; - /** @description Malformed or missing required body, headers or parameters */ - bulkTransferBadRequest: { - content: { - "application/json": components["schemas"]["bulkTransferErrorResponse"]; - }; - }; - /** @description Internal Server Error */ - errorResponse: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - bulkTransactionPutBadRequest: { - content: { - "application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"]; - }; - }; - /** @description Bulk transfer completed successfully */ - bulkTransferSuccess: { - content: { - "application/json": components["schemas"]["bulkTransferResponse"]; - }; - }; - /** @description PartiesByIdSuccess */ - partiesByIdSuccess: { - content: { - "application/json": components["schemas"]["partiesByIdResponse"]; - }; - }; - /** @description PartiesByIdError404 */ - partiesByIdError404: { - content: { - "application/json": { - errorInformation?: components["schemas"]["ErrorInformation"]; + schemas: { + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + accountsRequest: { + idType: components["schemas"]["PartyIdType"]; + idValue: components["schemas"]["PartyIdentifier"]; + idSubValue?: components["schemas"]["PartySubIdOrType"]; + currency: components["schemas"]["Currency"]; + }[]; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + errorResponse: { + /** @description Error code as string. */ + statusCode?: string; + /** @description Error message text. */ + message?: string; + }; + accountCreationStatus: { + idType: components["schemas"]["PartyIdType"]; + idValue: components["schemas"]["PartyIdentifier"]; + idSubValue?: components["schemas"]["PartySubIdOrType"]; + error?: components["schemas"]["errorResponse"]; + }[]; + /** @enum {string} */ + accountsCreationState: "ERROR_OCCURRED" | "COMPLETED"; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + mojaloopError: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** @description This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */ + transferError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + accountsResponse: { + modelId?: components["schemas"]["CorrelationId"]; + accounts: components["schemas"]["accountsRequest"]; + response?: components["schemas"]["accountCreationStatus"]; + currentState?: components["schemas"]["accountsCreationState"]; + lastError?: components["schemas"]["transferError"]; + postAccountsResponse?: { + body: Record; + headers?: Record; + }; + }; + errorAccountsResponse: components["schemas"]["errorResponse"] & { + executionState: components["schemas"]["accountsResponse"]; + }; + /** + * TransactionInitiatorType + * @description Below are the allowed values for the enumeration. + * - CONSUMER - Consumer is the initiator of the transaction. + * - AGENT - Agent is the initiator of the transaction. + * - BUSINESS - Business is the initiator of the transaction. + * - DEVICE - Device is the initiator of the transaction. + * @example CONSUMER + * @enum {string} + */ + TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** + * Name + * @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. + * + * 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 ( ). + * + * **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. + */ + Name: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + extensionListEmptiable: components["schemas"]["Extension"][]; + transferParty: { + type?: components["schemas"]["TransactionInitiatorType"]; + idType: components["schemas"]["PartyIdType"]; + idValue: components["schemas"]["PartyIdentifier"]; + idSubValue?: components["schemas"]["PartySubIdOrType"]; + displayName?: components["schemas"]["Name"]; + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["extensionListEmptiable"]; + }; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + /** + * transferTransactionType + * @description Type of transaction. + * @enum {string} + */ + transferTransactionType: "TRANSFER"; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * IndividualQuote + * @description Data model for the complex type 'individualQuote'. + */ + individualQuote: { + quoteId: components["schemas"]["CorrelationId"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + note?: components["schemas"]["Note"]; + extensions?: components["schemas"]["ExtensionList"]; + }; + bulkQuoteRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + bulkQuoteId?: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + /** @description List of individual quotes in a bulk quote. */ + individualQuotes: components["schemas"]["individualQuote"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + /** @enum {string} */ + bulkTransferStatus: "ERROR_OCCURRED" | "COMPLETED"; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** @description This object represents a Mojaloop API error received at any time during the quote process */ + quoteError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + individualQuoteResult: { + quoteId: components["schemas"]["CorrelationId"]; + transferAmount?: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket?: components["schemas"]["IlpPacket"]; + condition?: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["quoteError"]; + }; + bulkQuoteResponse: { + bulkQuoteId: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId?: string; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + currentState: components["schemas"]["bulkTransferStatus"]; + /** @description List of individualQuoteResults in a bulk transfer response. */ + individualQuoteResults: components["schemas"]["individualQuoteResult"][]; + }; + bulkQuoteErrorResponse: components["schemas"]["errorResponse"] & { + bulkQuoteState: components["schemas"]["bulkQuoteResponse"]; + }; + /** @enum {string} */ + bulkQuoteStatus: "ERROR_OCCURRED" | "COMPLETED"; + bulkQuoteStatusResponse: { + bulkQuoteId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["bulkQuoteStatus"]; + individualQuotes: components["schemas"]["individualQuote"][]; + }; + autoAcceptPartyOption: { + /** @enum {boolean} */ + enabled: false | true; + }; + bulkPerTransferFeeLimit: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + autoAcceptQuote: { + /** @enum {boolean} */ + enabled: true | false; + perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; + }; + bulkTransactionOptions: { + /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ + onlyValidateParty?: boolean; + autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; + /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ + autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ + synchronous?: boolean; + bulkExpiration: components["schemas"]["DateTime"]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** + * BulkTransactionIndividualTransfer + * @description Data model for the complex type 'bulkTransactionIndividualTransfer'. + */ + bulkTransactionIndividualTransfer: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + to: components["schemas"]["Party"]; + /** @description Payer Loan reference */ + reference?: string; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + note?: components["schemas"]["Note"]; + quoteExtensions?: components["schemas"]["ExtensionList"]; + transferExtensions?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["transferError"]; + }; + bulkTransactionRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + bulkHomeTransactionID: string; + bulkTransactionId: components["schemas"]["CorrelationId"]; + options: components["schemas"]["bulkTransactionOptions"]; + from: components["schemas"]["Party"]; + /** @description List of individual transfers in a bulk transfer. */ + individualTransfers: components["schemas"]["bulkTransactionIndividualTransfer"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @example RESERVED + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + individualTransferResult: { + transferId: components["schemas"]["CorrelationId"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + extensionList?: components["schemas"]["ExtensionList"]; + transferState?: components["schemas"]["TransferState"]; + lastError?: components["schemas"]["transferError"]; + }; + bulkTransferResponse: { + bulkTransferId: components["schemas"]["CorrelationId"]; + bulkQuoteId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId?: string; + bulkTransferState?: components["schemas"]["TransferState"]; + completedTimestamp?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + currentState: components["schemas"]["bulkTransferStatus"]; + /** @description List of individual transfer result in a bulk transfer response. */ + individualTransferResults: components["schemas"]["individualTransferResult"][]; + }; + bulkTransferErrorResponse: components["schemas"]["errorResponse"] & { + bulkTransferState: components["schemas"]["bulkTransferResponse"]; + }; + /** @description Data model for the 'individualTransfer' while accepting party or quote. */ + bulkTransactionIndividualTransferAccept: { + transferId: components["schemas"]["CorrelationId"]; + }; + transferContinuationAcceptParty: { + /** @enum {boolean} */ + acceptParty: true | false; + }; + /** @description The object sent back as confirmation of payee parties when autoAcceptParty is false. */ + bulkTransactionContinuationAcceptParty: { + /** @description List of individual transfers in a bulk transfer with accept party information. */ + individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptParty"])[]; + }; + transferContinuationAcceptQuote: { + /** @enum {boolean} */ + acceptQuote: true | false; + }; + /** @description The object sent back as confirmation of quotes when autoAcceptQuotes is false. */ + bulkTransactionContinuationAcceptQuote: { + /** @description List of individual transfers in a bulk transfer. */ + individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptQuote"])[]; + }; + /** @description This object represents a Mojaloop API error received at any time during the party discovery process */ + partyError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & { + bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"]; + }; + bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & { + bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"]; + }; + /** + * IndividualTransfer + * @description Data model for the complex type 'individualTransfer'. + */ + individualTransfer: { + transferId: components["schemas"]["CorrelationId"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType?: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + note?: components["schemas"]["Note"]; + extensions?: components["schemas"]["ExtensionList"]; + }; + bulkTransferRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + bulkTransferId: components["schemas"]["CorrelationId"]; + bulkQuoteId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + /** @description List of individual transfers in a bulk transfer. */ + individualTransfers: components["schemas"]["individualTransfer"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** @description A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer */ + individualTransferFulfilment: { + fulfilment?: components["schemas"]["IlpFulfilment"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + bulkTransferStatusResponse: { + bulkTransferId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["bulkTransferStatus"]; + fulfils: components["schemas"]["individualTransferFulfilment"][]; + }; + /** @enum {string} */ + async2SyncCurrentState: "WAITING_FOR_ACTION" | "COMPLETED" | "ERROR_OCCURRED"; + /** + * partiesByIdResponse + * @description GET /parties/{Type}/{ID} response object + */ + partiesByIdResponse: { + party: { + body: components["schemas"]["Party"]; + headers: Record; + }; + currentState: components["schemas"]["async2SyncCurrentState"]; + }; + /** + * TransactionScenario + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. + * - 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. + * - REFUND - Used for performing a refund of transaction. + * @example DEPOSIT + * @enum {string} + */ + TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; + /** + * TransactionInitiator + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * @example PAYEE + * @enum {string} + */ + TransactionInitiator: "PAYER" | "PAYEE"; + /** + * RefundReason + * @description Reason for the refund. + * @example Free text indicating reason for the refund. + */ + RefundReason: string; + /** + * Refund + * @description Data model for the complex type Refund. + */ + Refund: { + originalTransactionId: components["schemas"]["CorrelationId"]; + refundReason?: components["schemas"]["RefundReason"]; + }; + /** + * BalanceOfPayments + * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. + * @example 123 + */ + BalanceOfPayments: string; + /** + * TransactionType + * @description Data model for the complex type TransactionType. + */ + TransactionType: { + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + refundInfo?: components["schemas"]["Refund"]; + balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; + }; + /** + * QuotesPostRequest + * @description The object sent in the POST /quotes request. + */ + QuotesPostRequest: { + quoteId: components["schemas"]["CorrelationId"]; + transactionId: components["schemas"]["CorrelationId"]; + transactionRequestId?: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + amountType: components["schemas"]["AmountType"]; + amount: components["schemas"]["Money"]; + fees?: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + geoCode?: components["schemas"]["GeoCode"]; + note?: components["schemas"]["Note"]; + expiration?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** simpleQuotesPostRequest */ + simpleQuotesPostRequest: { + fspId: components["schemas"]["FspId"]; + quotesPostRequest: components["schemas"]["QuotesPostRequest"]; + }; + /** QuotesPostResponse */ + quotesPostResponse: { + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + quotes: { + body: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + /** + * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + headers: Record; + }; + currentState: components["schemas"]["async2SyncCurrentState"]; + }; + errorQuotesResponse: components["schemas"]["errorResponse"] & Record; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * - U2F - U2F is a new addition isolated to Thirdparty stream. + * @example OTP + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE" | "U2F"; + requestToPayRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId: string; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + }; + /** @enum {string} */ + requestToPayStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "COMPLETED"; + /** + * getPartiesResponse + * @description The object sent in the GET /parties/{Type}/{ID} callback. + */ + getPartiesResponse: { + body: components["schemas"]["Party"]; + headers: Record; + }; + /** + * TransactionRequestState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. + * - PENDING - Payer FSP has sent the transaction request to the Payer. + * - ACCEPTED - Payer has approved the transaction. + * - REJECTED - Payer has rejected the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * TransactionRequestResponse + * @description The object sent in the PUT /transactionRequests/{ID} callback. + */ + TransactionRequestResponse: { + body: { + transactionId?: components["schemas"]["CorrelationId"]; + transactionRequestState: components["schemas"]["TransactionRequestState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + headers: Record; + }; + requestToPayResponse: { + transactionRequestId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + currentState: components["schemas"]["requestToPayStatus"]; + getPartiesResponse?: components["schemas"]["getPartiesResponse"]; + transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"]; + lastError?: components["schemas"]["transferError"]; + }; + /** @enum {string} */ + transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + QuotesIDPutResponse: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + expiration: components["schemas"]["DateTime"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransfersIDPutResponse + * @description The object sent in the PUT /transfers/{ID} callback. + */ + TransfersIDPutResponse: { + fulfilment?: components["schemas"]["IlpFulfilment"]; + completedTimestamp?: components["schemas"]["DateTime"]; + transferState: components["schemas"]["TransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + transferResponse: { + transferId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + note?: components["schemas"]["Note"]; + currentState?: components["schemas"]["transferStatus"]; + quoteId?: components["schemas"]["CorrelationId"]; + getPartiesResponse?: { + body: Record; + headers?: Record; + }; + quoteResponse?: { + body: components["schemas"]["QuotesIDPutResponse"]; + headers?: Record; + }; + /** @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. + * */ + quoteResponseSource?: string; + fulfil?: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers?: Record; + }; + lastError?: components["schemas"]["transferError"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + }; + errorTransferResponse: components["schemas"]["errorResponse"] & { + transferState: components["schemas"]["transferResponse"]; + }; + requestToPayTransferRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId: string; + transactionRequestId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + note?: components["schemas"]["Note"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + }; + /** + * AuthenticationValue + * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. + */ + AuthenticationValue: string | { + /** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. + * */ + pinValue: string; + /** + * Integer + * @description Sequential counter used for cloning detection. Present only for U2F authentication. + */ + counter: string; + }; + /** + * AuthenticationInfo + * @description Data model for the complex type AuthenticationInfo. + */ + AuthenticationInfo: { + authentication: components["schemas"]["AuthenticationType"]; + authenticationValue: components["schemas"]["AuthenticationValue"]; + }; + /** + * AuthorizationResponseType + * @description Below are the allowed values for the enumeration. + * - ENTERED - Consumer entered the authentication value. + * - REJECTED - Consumer rejected the transaction. + * - RESEND - Consumer requested to resend the authentication value. + * @example ENTERED + * @enum {string} + */ + AuthorizationResponseType: "ENTERED" | "REJECTED" | "RESEND"; + /** + * AuthorizationIDPutResponse + * @description The object sent in the PUT /authorizations/{ID} callback. + */ + AuthorizationIDPutResponse: { + authenticationInfo?: components["schemas"]["AuthenticationInfo"]; + responseType: components["schemas"]["AuthorizationResponseType"]; + }; + requestToPayTransferResponse: { + transferId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId?: string; + transactionRequestId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + note?: components["schemas"]["Note"]; + currentState?: components["schemas"]["transferStatus"]; + quoteId?: components["schemas"]["CorrelationId"]; + quoteResponse?: { + body: components["schemas"]["QuotesIDPutResponse"]; + headers?: Record; + }; + /** @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. + * */ + quoteResponseSource?: string; + authorizationResponse?: { + body: components["schemas"]["AuthorizationIDPutResponse"]; + headers?: Record; + }; + fulfil?: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers?: Record; + }; + lastError?: components["schemas"]["transferError"]; + }; + transferContinuationAcceptOTP: { + /** @enum {boolean} */ + acceptOTP: true | false; + }; + /** + * TransfersPostRequest + * @description The object sent in the POST /transfers request. + */ + TransfersPostRequest: { + transferId: components["schemas"]["CorrelationId"]; + payeeFsp: components["schemas"]["FspId"]; + payerFsp: components["schemas"]["FspId"]; + amount: components["schemas"]["Money"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** SimpleTransfersPostRequest */ + simpleTransfersPostRequest: { + fspId: components["schemas"]["FspId"]; + transfersPostRequest: components["schemas"]["TransfersPostRequest"]; + }; + /** SimpleTransfersPostResponse */ + simpleTransfersPostResponse: { + transfer: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers: Record; + }; + currentState: components["schemas"]["async2SyncCurrentState"]; + }; + errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & Record; + transferRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + note?: components["schemas"]["Note"]; + quoteRequestExtensions?: components["schemas"]["extensionListEmptiable"]; + transferRequestExtensions?: components["schemas"]["extensionListEmptiable"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + }; + transferStatusResponse: { + transferId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["transferStatus"]; + fulfil: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers?: Record; + }; }; - }; - }; - /** @description sync response from POST /quotes */ - quotesPostSuccess: { - content: { - "application/json": components["schemas"]["quotesPostResponse"]; - }; - }; - /** @description An error occurred processing the quotes request */ - quotesServerError: { - content: { - "application/json": components["schemas"]["errorQuotesResponse"]; - }; - }; - /** @description Request to Pay completed successfully */ - requestToPaySuccess: { - content: { - "application/json": components["schemas"]["requestToPayResponse"]; - }; - }; - /** @description An error occurred processing the transfer */ - transferServerError: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; - }; - /** @description Timeout occurred processing the transfer */ - transferTimeout: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; - }; - /** @description Transfer completed successfully */ - requestToPayTransferSuccess: { - content: { - "application/json": components["schemas"]["requestToPayTransferResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - requestToPayTransferBadRequest: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; - }; - /** @description Transfer completed successfully */ - transferSuccess: { - content: { - "application/json": components["schemas"]["transferResponse"]; - }; - }; - /** @description sync response from POST /simpleTransfers */ - simpleTransfersPostSuccess: { - content: { - "application/json": components["schemas"]["simpleTransfersPostResponse"]; - }; - }; - /** @description An error occurred processing the simple transfers request */ - simpleTransfersServerError: { - content: { - "application/json": components["schemas"]["errorSimpleTransfersResponse"]; - }; }; - /** @description Malformed or missing required body, headers or parameters */ - transferBadRequest: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; + responses: { + /** @description Accounts creation completed */ + accountsCreationCompleted: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["accountsResponse"]; + }; + }; + /** @description An error occurred creating accounts */ + accountsCreationError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorAccountsResponse"]; + }; + }; + /** @description Timeout occurred creating accounts */ + accountsCreationTimeout: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorAccountsResponse"]; + }; + }; + /** @description Bulk quote completed successfully */ + bulkQuoteSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + bulkQuoteBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteErrorResponse"]; + }; + }; + /** @description An error occurred processing the bulk quote */ + bulkQuoteServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteErrorResponse"]; + }; + }; + /** @description Timeout occurred processing the bulk quote */ + bulkQuoteTimeout: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteErrorResponse"]; + }; + }; + /** @description Bulk transfer accepted successfully */ + bulkTransactionAccepted: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Malformed or missing required body, headers or parameters */ + bulkTransferBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferErrorResponse"]; + }; + }; + /** @description Internal Server Error */ + errorResponse: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + bulkTransactionPutBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"]; + }; + }; + /** @description Bulk transfer completed successfully */ + bulkTransferSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferResponse"]; + }; + }; + /** @description PartiesByIdSuccess */ + partiesByIdSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["partiesByIdResponse"]; + }; + }; + /** @description PartiesByIdError404 */ + partiesByIdError404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + }; + }; + /** @description sync response from POST /quotes */ + quotesPostSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["quotesPostResponse"]; + }; + }; + /** @description An error occurred processing the quotes request */ + quotesServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorQuotesResponse"]; + }; + }; + /** @description Request to Pay completed successfully */ + requestToPaySuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["requestToPayResponse"]; + }; + }; + /** @description An error occurred processing the transfer */ + transferServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @description Timeout occurred processing the transfer */ + transferTimeout: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @description Transfer completed successfully */ + requestToPayTransferSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["requestToPayTransferResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + requestToPayTransferBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @description Transfer completed successfully */ + transferSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferResponse"]; + }; + }; + /** @description sync response from POST /simpleTransfers */ + simpleTransfersPostSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simpleTransfersPostResponse"]; + }; + }; + /** @description An error occurred processing the simple transfers request */ + simpleTransfersServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorSimpleTransfersResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + transferBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; }; - }; - parameters: { - /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ - bulkQuoteId: components["schemas"]["CorrelationId"]; - /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ - bulkTransactionId: components["schemas"]["CorrelationId"]; - /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ - bulkTransferId: components["schemas"]["CorrelationId"]; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - Type: string; - /** @description The identifier value. */ - ID: string; - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - SubId: string; - /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ - transactionRequestId: components["schemas"]["CorrelationId"]; - /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ - transferId: components["schemas"]["CorrelationId"]; - }; - requestBodies: never; - headers: never; - pathItems: never; + parameters: { + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkQuoteId: components["schemas"]["CorrelationId"]; + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["schemas"]["CorrelationId"]; + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkTransferId: components["schemas"]["CorrelationId"]; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The identifier value. */ + ID: string; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: string; + /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ + transactionRequestId: components["schemas"]["CorrelationId"]; + /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ + transferId: components["schemas"]["CorrelationId"]; + }; + requestBodies: never; + headers: never; + pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - - /** - * PartiesByTypeAndID - * @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). - */ - PartiesByTypeAndID: { - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 200: components["responses"]["partiesByIdSuccess"]; - 404: components["responses"]["partiesByIdError404"]; - }; - }; - /** - * PartiesSubIdByTypeAndID - * @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). - */ - PartiesSubIdByTypeAndID: { - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 200: components["responses"]["partiesByIdSuccess"]; - 404: components["responses"]["partiesByIdError404"]; - }; - }; - /** - * Quotes endpoint - * @description is used to request quotes from other DFSP - */ - QuotesPost: { - /** @description Quotes request payload */ - requestBody: { - content: { - "application/json": components["schemas"]["simpleQuotesPostRequest"]; - }; + PartiesByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["partiesByIdSuccess"]; + 404: components["responses"]["partiesByIdError404"]; + }; }; - responses: { - 200: components["responses"]["quotesPostSuccess"]; - 500: components["responses"]["quotesServerError"]; + PartiesSubIdByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["partiesByIdSuccess"]; + 404: components["responses"]["partiesByIdError404"]; + }; }; - }; - /** - * Simple Transfers endpoint - * @description is used to request a transfer - */ - SimpleTransfersPost: { - /** @description Simple Transfer request payload */ - requestBody: { - content: { - "application/json": components["schemas"]["simpleTransfersPostRequest"]; - }; + QuotesPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Quotes request payload */ + requestBody: { + content: { + "application/json": components["schemas"]["simpleQuotesPostRequest"]; + }; + }; + responses: { + 200: components["responses"]["quotesPostSuccess"]; + 500: components["responses"]["quotesServerError"]; + }; }; - responses: { - 200: components["responses"]["simpleTransfersPostSuccess"]; - 500: components["responses"]["simpleTransfersServerError"]; + SimpleTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Simple Transfer request payload */ + requestBody: { + content: { + "application/json": components["schemas"]["simpleTransfersPostRequest"]; + }; + }; + responses: { + 200: components["responses"]["simpleTransfersPostSuccess"]; + 500: components["responses"]["simpleTransfersServerError"]; + }; }; - }; } diff --git a/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts b/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts index d09faaa2..bade95d6 100644 --- a/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts +++ b/src/sdk-scheme-adapter/v2_1_0/backend/openapi.ts @@ -3,1482 +3,1839 @@ * Do not make direct changes to the file. */ - export interface paths { - "/": { - /** Health check endpoint. */ - get: operations["BackendHealthCheck"]; - }; - "/bulkQuotes": { - /** Requests a bulk quote. */ - post: operations["BackendBulkQuotesPost"]; - }; - "/bulkQuotes/{idValue}": { - /** Requests information relating to a bulk quote identified by the specified identifier value. */ - get: operations["BackendBulkQuotesGet"]; - }; - "/bulkTransactions/{bulkTransactionId}": { - /** - * Callbacks for the bulk transaction request. - * @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. - */ - put: operations["BackendBulkTransactionsPut"]; - }; - "/requestToPay/{transactionRequestId}": { - /** - * Callback for the requestToPay request. - * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer. - */ - put: operations["RequestToPayPut"]; - }; - "/bulkTransfers": { - /** Execute bulk transfer of funds from an external account to internal accounts. */ - post: operations["BackendBulkTransfersPost"]; - }; - "/bulkTransfers/{idValue}": { - /** Requests information relating to a bulk transfer identified by the specified identifier value. */ - get: operations["BackendBulkTransfersGet"]; - }; - "/otp/{transactionRequestId}": { - /** Requests OTP. */ - get: operations["BackendOtpGet"]; - }; - "/participants/{idType}/{idValue}": { - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. - */ - get: operations["BackendParticipantsGetByTypeAndID"]; - }; - "/participants/{idType}/{idValue}/{idSubValue}": { - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. - */ - get: operations["BackendParticipantsGetByTypeIDAndSubId"]; - }; - "/parties/{idType}/{idValue}": { - /** - * Requests information relating to a transfer party identified by the specified identifier type and value. - * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. - */ - get: operations["BackendPartiesGetByTypeAndID"]; - }; - "/parties/{idType}/{idValue}/{idSubValue}": { - /** - * Requests information relating to a transfer party identified by the specified identifier type, value and subId value. - * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. - */ - get: operations["BackendPartiesGetByTypeIdAndSubId"]; - }; - "/quoterequests": { - /** - * Requests a quote for the specified transfer. - * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. - */ - post: operations["BackendQuoteRequest"]; - }; - "/transactionrequests": { - /** Transaction request that supports pull based transfers. */ - post: operations["BackendTransactionRequest"]; - }; - "/transfers": { - /** - * Transfers funds from an external account to an internal account. - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. - */ - post: operations["BackendTransfersPost"]; - }; - "/transfers/{transferId}": { - /** - * Retrieves information for a specific transfer. - * @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. - */ - get: operations["BackendTransfersGet"]; - /** - * Receive notification for a specific transfer. - * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. - */ - put: operations["BackendTransfersPut"]; - }; - "/fxQuotes": { - /** - * Calculate FX quote - * @description The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion. - */ - post: operations["FxQuotesPost"]; - }; - "/fxTransfers": { - /** - * Perform FX transfer - * @description The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion. - */ - post: operations["FxTransfersPost"]; - }; - "/fxTransfers/{commitRequestId}": { - /** - * FX Commit Notification - * @description The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion. - */ - put: operations["FxTransfersById"]; - }; + "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Health check endpoint. */ + get: operations["BackendHealthCheck"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Requests a bulk quote. */ + post: operations["BackendBulkQuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Requests information relating to a bulk quote identified by the specified identifier value. */ + get: operations["BackendBulkQuotesGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransactions/{bulkTransactionId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Callbacks for the bulk transaction request. + * @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. + */ + put: operations["BackendBulkTransactionsPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPay/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Callback for the requestToPay request. + * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer. + */ + put: operations["RequestToPayPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Execute bulk transfer of funds from an external account to internal accounts. */ + post: operations["BackendBulkTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Requests information relating to a bulk transfer identified by the specified identifier value. */ + get: operations["BackendBulkTransfersGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/otp/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** Requests OTP. */ + get: operations["BackendOtpGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{idType}/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. + * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. + */ + get: operations["BackendParticipantsGetByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{idType}/{idValue}/{idSubValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. + * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. + */ + get: operations["BackendParticipantsGetByTypeIDAndSubId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{idType}/{idValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Requests information relating to a transfer party identified by the specified identifier type and value. + * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. + */ + get: operations["BackendPartiesGetByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{idType}/{idValue}/{idSubValue}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Requests information relating to a transfer party identified by the specified identifier type, value and subId value. + * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. + */ + get: operations["BackendPartiesGetByTypeIdAndSubId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quoterequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Requests a quote for the specified transfer. + * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. + */ + post: operations["BackendQuoteRequest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transactionrequests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** Transaction request that supports pull based transfers. */ + post: operations["BackendTransactionRequest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Transfers funds from an external account to an internal account. + * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. + */ + post: operations["BackendTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{transferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific transfer. + * @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. + */ + get: operations["BackendTransfersGet"]; + /** + * Receive notification for a specific transfer. + * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. + */ + put: operations["BackendTransfersPut"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate FX quote + * @description The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion. + */ + post: operations["FxQuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform FX transfer + * @description The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion. + */ + post: operations["FxTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers/{commitRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * FX Commit Notification + * @description The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion. + */ + put: operations["FxTransfersById"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** @description Data model for individual quote in a bulk quote request. */ - IndividualQuote: { - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - feesAmount?: components["schemas"]["money"]; - feesCurrency?: components["schemas"]["currency"]; - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the quote. */ - note?: string; - quoteId: components["schemas"]["quoteId"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to: components["schemas"]["transferParty"]; - transactionId: components["schemas"]["transactionId"]; - transactionType: components["schemas"]["transactionType"]; - }; - /** @description Data model for failed individual quote in a bulk quote response. */ - IndividualQuoteResultFailed: { - errorResponse: components["schemas"]["errorResponse"]; - quoteId: components["schemas"]["quoteId"]; - }; - /** @description Data model for successful individual quote in a bulk quote response. */ - IndividualQuoteResultSuccess: { - payeeFspCommissionAmount?: components["schemas"]["money"]; - payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; - payeeFspFeeAmount?: components["schemas"]["money"]; - payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; - payeeReceiveAmount?: components["schemas"]["money"]; - payeeReceiveAmountCurrency?: components["schemas"]["currency"]; - quoteId: components["schemas"]["quoteId"]; - transferAmount?: components["schemas"]["money"]; - transferAmountCurrency?: components["schemas"]["currency"]; - }; - /** @description Data model for individual transfer in a bulk transfer request. */ - IndividualTransfer: { - amount: components["schemas"]["money"]; - amountType?: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - feesAmount?: components["schemas"]["money"]; - feesCurrency?: components["schemas"]["currency"]; - initiator?: components["schemas"]["initiator"]; - initiatorType?: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the quote. */ - note?: string; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to?: components["schemas"]["transferParty"]; - transactionType?: components["schemas"]["transactionType"]; - transferId: components["schemas"]["transferId"]; - }; - /** @description Data model for individual transfer in a bulk transfer response. */ - IndividualTransferResult: { - errorResponse?: components["schemas"]["errorResponse"]; - extensionList?: components["schemas"]["extensionList"]; - transferId: components["schemas"]["transferId"]; - }; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** @description Object containing Amount and Currency of the transfer. */ - amountCurrency: { - amount: components["schemas"]["money"]; - currency: components["schemas"]["currency"]; - }; - /** @enum {string} */ - amountType: "SEND" | "RECEIVE"; - /** @description A Mojaloop API bulk quote identifier (UUID). */ - bulkQuoteId: string; - /** @description A request for a bulk quote. */ - bulkQuoteRequest: { - bulkQuoteId: components["schemas"]["bulkQuoteId"]; - expiration?: components["schemas"]["timestamp"]; - from: components["schemas"]["transferParty"]; - geoCode?: components["schemas"]["geoCode"]; - individualQuotes: components["schemas"]["IndividualQuote"][]; - }; - /** @description A response to a request for a bulk quote. */ - bulkQuoteResponse: { - bulkQuoteId: components["schemas"]["bulkQuoteId"]; - expiration?: components["schemas"]["timestamp"]; - /** @description Fees for each individual transaction, if any of them are charged per transaction. */ - individualQuoteResults: (components["schemas"]["IndividualQuoteResultSuccess"] | components["schemas"]["IndividualQuoteResultFailed"])[]; - }; - /** @description A Mojaloop API transfer identifier (UUID). */ - bulkTransferId: string; - bulkTransferRequest: { - bulkQuote?: components["schemas"]["bulkQuoteResponse"]; - bulkTransferId: components["schemas"]["bulkTransferId"]; - from?: components["schemas"]["transferParty"]; - individualTransfers: components["schemas"]["IndividualTransfer"][]; - }; - bulkTransferResponse: { - bulkTransferId?: components["schemas"]["bulkTransferId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the switch and DFSP backend systems. */ - homeTransactionId: string; - individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; - }; - /** @enum {string} */ - currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** @description Date of birth in the form YYYY-MM-DD. */ - dateOfBirth: string; - /** - * ErrorCode - * @description The API data type errorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represents the specific error. - */ - errorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - errorDescription: string; - /** - * ErrorInformation - * @description A Mojaloop API error information construct. - */ - errorInformation: { - errorCode: components["schemas"]["errorCode"]; - errorDescription: components["schemas"]["errorDescription"]; - extensionList?: components["schemas"]["extensionListComplex"]; - }; - extensionItem: { - key?: string; - value?: string; - }; - extensionList: components["schemas"]["extensionItem"][]; - /** @description Data model for the complex type ExtensionList. */ - extensionListComplex: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["extensionItem"][]; - }; - /** @description FSP identifier. */ - fspId: string; - /** - * TransfersIDPatchResponse - * @description PUT /transfers/{transferId} object. - */ - fulfilNotification: { - currentState?: components["schemas"]["transferStatus"]; - /** @enum {string} */ - direction?: "INBOUND"; - finalNotification?: { - completedTimestamp: components["schemas"]["timestamp"]; - extensionList?: components["schemas"]["extensionList"]; - transferState: components["schemas"]["transferState"]; - }; - fulfil?: { - body?: Record; - headers?: Record; - }; - initiatedTimestamp?: components["schemas"]["timestamp"]; - lastError?: components["schemas"]["transferError"]; - prepare?: { - body?: Record; - headers?: Record; - }; - quote?: { - fulfilment?: string; - internalRequest?: Record; - mojaloopResponse?: Record; - request?: Record; - response?: Record; - }; - quoteRequest?: { - body?: Record; - headers?: Record; - }; - quoteResponse?: { - body?: Record; - headers?: Record; - }; - transferId?: components["schemas"]["transferId"]; - }; - /** @description This object may represent a number of different error object types and so its properties may vary significantly. */ - generalError: Record; - /** @description Indicates the geographic location from where the transaction was initiated. */ - geoCode: { - latitude: components["schemas"]["latitude"]; - longitude: components["schemas"]["longitude"]; - }; - idSubValue: string; - /** @enum {string} */ - idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** @description Identifier of the party. */ - idValue: string; - /** @description Object containing transfer object. */ - ilpPacketData: { - amount: components["schemas"]["amountCurrency"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - quoteId: components["schemas"]["quoteId"]; - transactionId: components["schemas"]["transactionId"]; - transactionType: components["schemas"]["transactionTypeObject"]; - }; - /** @enum {string} */ - initiator: "PAYER" | "PAYEE"; - /** @enum {string} */ - initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ - latitude: string; - /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ - longitude: string; - money: string; - otpDetails: { - /** @description OTP value. */ - otpValue: string; - }; - participantsResponse: { - fspId?: components["schemas"]["fspId"]; - }; - /** @enum {string} */ - payerType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** @description A Mojaloop API quote identifier (UUID). */ - quoteId: string; - /** @description A request for a quote for transfer from the DFSP backend. */ - quoteRequest: { - /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ - homeR2PTransactionId?: string; - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - expiration?: components["schemas"]["timestamp"]; - extensionList?: components["schemas"]["extensionList"]; - feesAmount?: components["schemas"]["money"]; - feesCurrency?: components["schemas"]["currency"]; - from: components["schemas"]["transferParty"]; - geoCode?: components["schemas"]["geoCode"]; - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the requested transfer. */ - note?: string; - quoteId: components["schemas"]["quoteId"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to: components["schemas"]["transferParty"]; - transactionId: components["schemas"]["transactionId"]; - transactionType: components["schemas"]["transactionType"]; - transactionRequestId?: components["schemas"]["transactionRequestId"]; - converter?: components["schemas"]["CurrencyConverter"]; - currencyConversion?: components["schemas"]["FxRate"]; - }; - /** @description A response to a request for a quote. */ - quoteResponse: { - expiration?: components["schemas"]["timestamp"]; - extensionList?: components["schemas"]["extensionList"]; - geoCode?: components["schemas"]["geoCode"]; - payeeFspCommissionAmount?: components["schemas"]["money"]; - payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; - payeeFspFeeAmount?: components["schemas"]["money"]; - payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; - payeeReceiveAmount?: components["schemas"]["money"]; - payeeReceiveAmountCurrency?: components["schemas"]["currency"]; - quoteId: components["schemas"]["quoteId"]; - transactionId: components["schemas"]["transactionId"]; - transferAmount: components["schemas"]["money"]; - transferAmountCurrency: components["schemas"]["currency"]; - }; - /** @enum {string} */ - scenario: "TRANSFER"; - /** @description An ISO-8601 formatted timestamp. */ - timestamp: string; - /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */ - transactionId: string; - /** @description A request for a pull based transfer. */ - transactionRequest: { - amount: components["schemas"]["money"]; - currency: components["schemas"]["currency"]; - expiration?: components["schemas"]["timestamp"]; - from: components["schemas"]["transferParty"]; - geoCode?: components["schemas"]["geoCode"]; - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - /** @description An optional note associated with the requested transfer. */ - note?: string; - to: components["schemas"]["transferParty"]; - transactionRequestId: components["schemas"]["transactionRequestId"]; - transactionType: components["schemas"]["transactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - }; - /** @description A Mojaloop API transaction request identifier (UUID). */ - transactionRequestId: string; - /** @description A response to a request for a quote. */ - transactionRequestResponse: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId?: string; - transactionId: components["schemas"]["transactionId"]; - transactionRequestState: components["schemas"]["transactionRequestState"]; - }; - /** @enum {string} */ - transactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * transactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario. - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - transactionSubScenario: string; - /** @enum {string} */ - transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT"; - /** @description Object containing transfer object. */ - transactionTypeObject: { - initiator: components["schemas"]["initiator"]; - initiatorType: components["schemas"]["initiatorType"]; - scenario: components["schemas"]["scenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - }; - transferDetailsResponse: { - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - extensions?: components["schemas"]["extensionList"]; - from: components["schemas"]["transferParty"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - note?: string; - subScenario?: components["schemas"]["TransactionSubScenario"]; - timestamp: components["schemas"]["timestamp"]; - to: components["schemas"]["transferParty"]; - transactionType: components["schemas"]["transactionType"]; - transferState: components["schemas"]["transferState"]; - }; - /** @description A Mojaloop API transfer identifier (UUID). */ - transferId: string; - transferParty: { - dateOfBirth?: components["schemas"]["dateOfBirth"]; - /** @description Display name of the sender, if known. */ - displayName?: string; - extensionList?: components["schemas"]["extensionList"]; - /** @description Party first name. */ - firstName?: string; - /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */ - fspId?: string; - idSubValue?: components["schemas"]["idSubValue"]; - idType: components["schemas"]["idType"]; - /** @description The identifier string used to identify the sender. */ - idValue: string; - /** @description Party last name. */ - lastName?: string; - /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */ - merchantClassificationCode?: string; - /** @description Party middle name. */ - middleName?: string; - type?: components["schemas"]["payerType"]; - /** @description Currencies in which the party can receive funds. */ - supportedCurrencies?: components["schemas"]["currency"][]; - kycInformation?: components["schemas"]["KYCInformation"]; - }; - transferRequest: { - /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ - homeR2PTransactionId?: string; - amount: components["schemas"]["money"]; - amountType: components["schemas"]["amountType"]; - currency: components["schemas"]["currency"]; - from: components["schemas"]["transferParty"]; - ilpPacket: { - data: components["schemas"]["ilpPacketData"]; - }; - note?: string; - quote: components["schemas"]["quoteResponse"]; - quoteRequestExtensions?: components["schemas"]["extensionList"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - to: components["schemas"]["transferParty"]; - transactionType: components["schemas"]["transactionType"]; - transferId: components["schemas"]["transferId"]; - transactionRequestId?: components["schemas"]["transactionRequestId"]; - }; - transferResponse: { - completedTimestamp?: components["schemas"]["timestamp"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - transferState?: components["schemas"]["transferState"]; - }; - /** - * @description Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer. - * - * @enum {string} - */ - transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** @enum {string} */ - transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; - /** @description Callback for requestToPay. */ - requestToPayCallback: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId?: string; - transactionRequestState: components["schemas"]["transactionRequestState"]; - }; - /** - * KYCInformation - * @description KYC information for the party in a form mandated by an individual scheme. - * @example { - * "metadata": { - * "format": "JSON", - * "version": "1.0", - * "description": "Data containing KYC Information" - * }, - * "data": { - * "name": "John Doe", - * "dob": "1980-05-15", - * "gender": "Male", - * "address": "123 Main Street, Anytown, USA", - * "email": "johndoe@example.com", - * "phone": "+1 555-123-4567", - * "nationality": "US", - * "passport_number": "AB1234567", - * "issue_date": "2010-02-20", - * "expiry_date": "2025-02-20", - * "bank_account_number": "1234567890", - * "bank_name": "Example Bank", - * "employer": "ABC Company", - * "occupation": "Software Engineer", - * "income": "$80,000 per year", - * "marital_status": "Single", - * "dependents": 0, - * "risk_level": "Low" - * } - * } - */ - KYCInformation: string; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - errorResponse: { - /** - * @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. - * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message. - */ - statusCode?: string; - /** @description Error message text. */ - message?: string; - }; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - /** @enum {string} */ - bulkTransactionStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; - autoAcceptPartyOption: { - /** @enum {boolean} */ - enabled: false | true; - }; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - bulkPerTransferFeeLimit: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - autoAcceptQuote: { - /** @enum {boolean} */ - enabled: true | false; - perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; - }; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - bulkTransactionOptions: { - /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ - onlyValidateParty?: boolean; - autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; - /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ - autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ - synchronous?: boolean; - bulkExpiration: components["schemas"]["DateTime"]; - }; - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - kycInformation?: components["schemas"]["KYCInformation"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - /** @description Currencies in which the party can receive funds. */ - supportedCurrencies?: components["schemas"]["Currency"][]; - }; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - mojaloopError: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** @description This object represents a Mojaloop API error received at any time during the quote process */ - quoteError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - individualQuoteResult: { - quoteId: components["schemas"]["CorrelationId"]; - transferAmount?: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket?: components["schemas"]["IlpPacket"]; - condition?: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["quoteError"]; - }; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @example RESERVED - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** @description This object represents a Mojaloop API error received at any time during the transfer process */ - transferError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - individualTransferResult: { - transferId: components["schemas"]["CorrelationId"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - extensionList?: components["schemas"]["ExtensionList"]; - transferState?: components["schemas"]["TransferState"]; - lastError?: components["schemas"]["transferError"]; - }; - bulkTransactionIndividualTransferResult: { - transferId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - transactionId?: components["schemas"]["CorrelationId"]; - to?: components["schemas"]["Party"]; - /** @description Payer Loan reference */ - reference?: string; - amountType?: components["schemas"]["AmountType"]; - currency?: components["schemas"]["Currency"]; - amount?: components["schemas"]["Amount"]; - note?: components["schemas"]["Note"]; - quoteId?: components["schemas"]["CorrelationId"]; - quoteResponse?: components["schemas"]["individualQuoteResult"]; - fulfil?: components["schemas"]["individualTransferResult"]; - quoteExtensions?: components["schemas"]["ExtensionList"]; - transferExtensions?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["transferError"]; - }; - /** BulkTransactionResponse */ - bulkTransactionResponse: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - bulkHomeTransactionID: string; - bulkTransactionId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["bulkTransactionStatus"]; - options?: components["schemas"]["bulkTransactionOptions"]; - /** @description List of individual transfer result in a bulk transfer response. */ - individualTransferResults: components["schemas"]["bulkTransactionIndividualTransferResult"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** - * CurrencyConverter - * @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee. - * @enum {string} - */ - CurrencyConverter: "PAYER" | "PAYEE"; - /** - * FxRate - * @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. - */ - FxRate: { - sourceAmount: components["schemas"]["Money"]; - targetAmount: components["schemas"]["Money"]; - }; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * - U2F - U2F is a new addition isolated to Thirdparty stream. - * @example OTP - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE" | "U2F"; - /** - * FxMoney - * @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations. - */ - FxMoney: { - currency: components["schemas"]["Currency"]; - amount?: components["schemas"]["Amount"]; - }; - /** - * FxCharge - * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object. - */ - FxCharge: { - /** @description A description of the charge which is being levied. */ - chargeType: string; - sourceAmount?: components["schemas"]["Money"]; - targetAmount?: components["schemas"]["Money"]; - }; - /** - * FxConversion - * @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. - */ - FxConversion: { - conversionId: components["schemas"]["CorrelationId"]; - determiningTransferId?: components["schemas"]["CorrelationId"]; - initiatingFsp: components["schemas"]["FspId"]; - counterPartyFsp: components["schemas"]["FspId"]; - amountType: components["schemas"]["AmountType"]; - sourceAmount: components["schemas"]["FxMoney"]; - targetAmount: components["schemas"]["FxMoney"]; - expiration: components["schemas"]["DateTime"]; - /** @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. */ - charges?: components["schemas"]["FxCharge"][]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxQuotesPostBackendRequest - * @description The object sent in the POST /fxQuotes request. - */ - FxQuotesPostBackendRequest: { - conversionRequestId: components["schemas"]["CorrelationId"]; - conversionTerms: components["schemas"]["FxConversion"]; - }; - /** - * FxQuotesPostBackendResponse - * @description The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester. - */ - FxQuotesPostBackendResponse: { - /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ - homeTransactionId?: string; - conversionTerms: components["schemas"]["FxConversion"]; - }; - commitRequestId: components["schemas"]["CorrelationId"]; - determiningTransferId: components["schemas"]["CorrelationId"]; - initiatingFsp: components["schemas"]["FspId"]; - counterPartyFsp: components["schemas"]["FspId"]; - sourceAmount: components["schemas"]["Money"]; - targetAmount: components["schemas"]["Money"]; - condition: components["schemas"]["IlpCondition"]; - /** - * FxTransfersPostBackendRequest - * @description The object sent in the POST /fxTransfers request. - */ - FxTransfersPostBackendRequest: { - /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ - homeTransactionId?: string; - commitRequestId: components["schemas"]["commitRequestId"]; - determiningTransferId?: components["schemas"]["determiningTransferId"]; - initiatingFsp: components["schemas"]["initiatingFsp"]; - counterPartyFsp: components["schemas"]["counterPartyFsp"]; - sourceAmount: components["schemas"]["sourceAmount"]; - targetAmount: components["schemas"]["targetAmount"]; - condition?: components["schemas"]["condition"]; - }; - fulfilment: components["schemas"]["IlpFulfilment"]; - completedTimestamp: components["schemas"]["DateTime"]; - conversionState: components["schemas"]["TransferState"]; - /** - * FxTransfersPostBackendResponse - * @description The object sent as a response for the POST /fxTransfers request. - */ - FxTransfersPostBackendResponse: { - /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ - homeTransactionId?: string; - fulfilment?: components["schemas"]["fulfilment"]; - completedTimestamp?: components["schemas"]["completedTimestamp"]; - conversionState: components["schemas"]["conversionState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxTransfersPutBackendRequest - * @description PUT /fxTransfers/{commitRequestId} object - */ - FxTransfersPutBackendRequest: { - /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ - homeTransactionId?: string; - fulfilment?: components["schemas"]["fulfilment"]; - completedTimestamp?: components["schemas"]["completedTimestamp"]; - conversionState: components["schemas"]["conversionState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - /** @description Malformed or missing required headers or parameters. */ - 400: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - /** @description Not Found */ - 404: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + schemas: { + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** @description Data model for individual quote in a bulk quote request. */ + IndividualQuote: { + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + feesAmount?: components["schemas"]["money"]; + feesCurrency?: components["schemas"]["currency"]; + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the quote. */ + note?: string; + quoteId: components["schemas"]["quoteId"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to: components["schemas"]["transferParty"]; + transactionId: components["schemas"]["transactionId"]; + transactionType: components["schemas"]["transactionType"]; + }; + /** @description Data model for failed individual quote in a bulk quote response. */ + IndividualQuoteResultFailed: { + errorResponse: components["schemas"]["errorResponse"]; + quoteId: components["schemas"]["quoteId"]; + }; + /** @description Data model for successful individual quote in a bulk quote response. */ + IndividualQuoteResultSuccess: { + payeeFspCommissionAmount?: components["schemas"]["money"]; + payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; + payeeFspFeeAmount?: components["schemas"]["money"]; + payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; + payeeReceiveAmount?: components["schemas"]["money"]; + payeeReceiveAmountCurrency?: components["schemas"]["currency"]; + quoteId: components["schemas"]["quoteId"]; + transferAmount?: components["schemas"]["money"]; + transferAmountCurrency?: components["schemas"]["currency"]; + }; + /** @description Data model for individual transfer in a bulk transfer request. */ + IndividualTransfer: { + amount: components["schemas"]["money"]; + amountType?: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + feesAmount?: components["schemas"]["money"]; + feesCurrency?: components["schemas"]["currency"]; + initiator?: components["schemas"]["initiator"]; + initiatorType?: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the quote. */ + note?: string; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to?: components["schemas"]["transferParty"]; + transactionType?: components["schemas"]["transactionType"]; + transferId: components["schemas"]["transferId"]; + }; + /** @description Data model for individual transfer in a bulk transfer response. */ + IndividualTransferResult: { + errorResponse?: components["schemas"]["errorResponse"]; + extensionList?: components["schemas"]["extensionList"]; + transferId: components["schemas"]["transferId"]; + }; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** @description Object containing Amount and Currency of the transfer. */ + amountCurrency: { + amount: components["schemas"]["money"]; + currency: components["schemas"]["currency"]; + }; + /** @enum {string} */ + amountType: "SEND" | "RECEIVE"; + /** @description A Mojaloop API bulk quote identifier (UUID). */ + bulkQuoteId: string; + /** @description A request for a bulk quote. */ + bulkQuoteRequest: { + bulkQuoteId: components["schemas"]["bulkQuoteId"]; + expiration?: components["schemas"]["timestamp"]; + from: components["schemas"]["transferParty"]; + geoCode?: components["schemas"]["geoCode"]; + individualQuotes: components["schemas"]["IndividualQuote"][]; + }; + /** @description A response to a request for a bulk quote. */ + bulkQuoteResponse: { + bulkQuoteId: components["schemas"]["bulkQuoteId"]; + expiration?: components["schemas"]["timestamp"]; + /** @description Fees for each individual transaction, if any of them are charged per transaction. */ + individualQuoteResults: (components["schemas"]["IndividualQuoteResultSuccess"] | components["schemas"]["IndividualQuoteResultFailed"])[]; + }; + /** @description A Mojaloop API transfer identifier (UUID). */ + bulkTransferId: string; + bulkTransferRequest: { + bulkQuote?: components["schemas"]["bulkQuoteResponse"]; + bulkTransferId: components["schemas"]["bulkTransferId"]; + from?: components["schemas"]["transferParty"]; + individualTransfers: components["schemas"]["IndividualTransfer"][]; + }; + bulkTransferResponse: { + bulkTransferId?: components["schemas"]["bulkTransferId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the switch and DFSP backend systems. */ + homeTransactionId: string; + individualTransferResults?: components["schemas"]["IndividualTransferResult"][]; + }; + /** @enum {string} */ + currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** @description Date of birth in the form YYYY-MM-DD. */ + dateOfBirth: string; + /** + * ErrorCode + * @description The API data type errorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represents the specific error. + * + */ + errorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + errorDescription: string; + /** + * ErrorInformation + * @description A Mojaloop API error information construct. + */ + errorInformation: { + errorCode: components["schemas"]["errorCode"]; + errorDescription: components["schemas"]["errorDescription"]; + extensionList?: components["schemas"]["extensionListComplex"]; + }; + extensionItem: { + key?: string; + value?: string; + }; + extensionList: components["schemas"]["extensionItem"][]; + /** @description Data model for the complex type ExtensionList. */ + extensionListComplex: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["extensionItem"][]; + }; + /** @description FSP identifier. */ + fspId: string; + /** + * TransfersIDPatchResponse + * @description PUT /transfers/{transferId} object. + */ + fulfilNotification: { + currentState?: components["schemas"]["transferStatus"]; + /** @enum {string} */ + direction?: "INBOUND"; + finalNotification?: { + completedTimestamp: components["schemas"]["timestamp"]; + extensionList?: components["schemas"]["extensionList"]; + transferState: components["schemas"]["transferState"]; + }; + fulfil?: { + body?: Record; + headers?: Record; + }; + initiatedTimestamp?: components["schemas"]["timestamp"]; + lastError?: components["schemas"]["transferError"]; + prepare?: { + body?: Record; + headers?: Record; + }; + quote?: { + fulfilment?: string; + internalRequest?: Record; + mojaloopResponse?: Record; + request?: Record; + response?: Record; + }; + quoteRequest?: { + body?: Record; + headers?: Record; + }; + quoteResponse?: { + body?: Record; + headers?: Record; + }; + transferId?: components["schemas"]["transferId"]; + }; + /** @description This object may represent a number of different error object types and so its properties may vary significantly. */ + generalError: Record; + /** @description Indicates the geographic location from where the transaction was initiated. */ + geoCode: { + latitude: components["schemas"]["latitude"]; + longitude: components["schemas"]["longitude"]; + }; + idSubValue: string; + /** @enum {string} */ + idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** @description Identifier of the party. */ + idValue: string; + /** @description Object containing transfer object. */ + ilpPacketData: { + amount: components["schemas"]["amountCurrency"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + quoteId: components["schemas"]["quoteId"]; + transactionId: components["schemas"]["transactionId"]; + transactionType: components["schemas"]["transactionTypeObject"]; + }; + /** @enum {string} */ + initiator: "PAYER" | "PAYEE"; + /** @enum {string} */ + initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ + latitude: string; + /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */ + longitude: string; + money: string; + otpDetails: { + /** @description OTP value. */ + otpValue: string; + }; + participantsResponse: { + fspId?: components["schemas"]["fspId"]; + }; + /** @enum {string} */ + payerType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** @description A Mojaloop API quote identifier (UUID). */ + quoteId: string; + /** @description A request for a quote for transfer from the DFSP backend. */ + quoteRequest: { + /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ + homeR2PTransactionId?: string; + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + expiration?: components["schemas"]["timestamp"]; + extensionList?: components["schemas"]["extensionList"]; + feesAmount?: components["schemas"]["money"]; + feesCurrency?: components["schemas"]["currency"]; + from: components["schemas"]["transferParty"]; + geoCode?: components["schemas"]["geoCode"]; + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the requested transfer. */ + note?: string; + quoteId: components["schemas"]["quoteId"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to: components["schemas"]["transferParty"]; + transactionId: components["schemas"]["transactionId"]; + transactionType: components["schemas"]["transactionType"]; + transactionRequestId?: components["schemas"]["transactionRequestId"]; + converter?: components["schemas"]["CurrencyConverter"] & unknown; + currencyConversion?: components["schemas"]["FxRate"] & unknown; + }; + /** @description A response to a request for a quote. */ + quoteResponse: { + expiration?: components["schemas"]["timestamp"]; + extensionList?: components["schemas"]["extensionList"]; + geoCode?: components["schemas"]["geoCode"]; + payeeFspCommissionAmount?: components["schemas"]["money"]; + payeeFspCommissionAmountCurrency?: components["schemas"]["currency"]; + payeeFspFeeAmount?: components["schemas"]["money"]; + payeeFspFeeAmountCurrency?: components["schemas"]["currency"]; + payeeReceiveAmount?: components["schemas"]["money"]; + payeeReceiveAmountCurrency?: components["schemas"]["currency"]; + quoteId: components["schemas"]["quoteId"]; + transactionId: components["schemas"]["transactionId"]; + transferAmount: components["schemas"]["money"]; + transferAmountCurrency: components["schemas"]["currency"]; + }; + /** @enum {string} */ + scenario: "TRANSFER"; + /** @description An ISO-8601 formatted timestamp. */ + timestamp: string; + /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */ + transactionId: string; + /** @description A request for a pull based transfer. */ + transactionRequest: { + amount: components["schemas"]["money"]; + currency: components["schemas"]["currency"]; + expiration?: components["schemas"]["timestamp"]; + from: components["schemas"]["transferParty"]; + geoCode?: components["schemas"]["geoCode"]; + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + /** @description An optional note associated with the requested transfer. */ + note?: string; + to: components["schemas"]["transferParty"]; + transactionRequestId: components["schemas"]["transactionRequestId"]; + transactionType: components["schemas"]["transactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + }; + /** @description A Mojaloop API transaction request identifier (UUID). */ + transactionRequestId: string; + /** @description A response to a request for a quote. */ + transactionRequestResponse: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId?: string; + transactionId: components["schemas"]["transactionId"]; + transactionRequestState: components["schemas"]["transactionRequestState"]; + }; + /** @enum {string} */ + transactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * transactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario. + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + transactionSubScenario: string; + /** @enum {string} */ + transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT"; + /** @description Object containing transfer object. */ + transactionTypeObject: { + initiator: components["schemas"]["initiator"]; + initiatorType: components["schemas"]["initiatorType"]; + scenario: components["schemas"]["scenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + }; + transferDetailsResponse: { + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + extensions?: components["schemas"]["extensionList"]; + from: components["schemas"]["transferParty"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + note?: string; + subScenario?: components["schemas"]["TransactionSubScenario"]; + timestamp: components["schemas"]["timestamp"]; + to: components["schemas"]["transferParty"]; + transactionType: components["schemas"]["transactionType"]; + transferState: components["schemas"]["transferState"]; + }; + /** @description A Mojaloop API transfer identifier (UUID). */ + transferId: string; + transferParty: { + dateOfBirth?: components["schemas"]["dateOfBirth"]; + /** @description Display name of the sender, if known. */ + displayName?: string; + extensionList?: components["schemas"]["extensionList"]; + /** @description Party first name. */ + firstName?: string; + /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */ + fspId?: string; + idSubValue?: components["schemas"]["idSubValue"]; + idType: components["schemas"]["idType"]; + /** @description The identifier string used to identify the sender. */ + idValue: string; + /** @description Party last name. */ + lastName?: string; + /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */ + merchantClassificationCode?: string; + /** @description Party middle name. */ + middleName?: string; + type?: components["schemas"]["payerType"]; + /** @description Currencies in which the party can receive funds. */ + supportedCurrencies?: components["schemas"]["currency"][]; + kycInformation?: components["schemas"]["KYCInformation"]; + }; + transferRequest: { + /** @description Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer. */ + homeR2PTransactionId?: string; + amount: components["schemas"]["money"]; + amountType: components["schemas"]["amountType"]; + currency: components["schemas"]["currency"]; + from: components["schemas"]["transferParty"]; + ilpPacket: { + data: components["schemas"]["ilpPacketData"]; + }; + note?: string; + quote: components["schemas"]["quoteResponse"]; + quoteRequestExtensions?: components["schemas"]["extensionList"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + to: components["schemas"]["transferParty"]; + transactionType: components["schemas"]["transactionType"]; + transferId: components["schemas"]["transferId"]; + transactionRequestId?: components["schemas"]["transactionRequestId"]; + }; + transferResponse: { + completedTimestamp?: components["schemas"]["timestamp"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + transferState?: components["schemas"]["transferState"]; + }; + /** + * @description Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer. + * + * @enum {string} + */ + transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** @enum {string} */ + transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; + /** @description Callback for requestToPay. */ + requestToPayCallback: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId?: string; + transactionRequestState: components["schemas"]["transactionRequestState"]; + }; + /** + * KYCInformation + * @description KYC information for the party in a form mandated by an individual scheme. + * @example { + * "metadata": { + * "format": "JSON", + * "version": "1.0", + * "description": "Data containing KYC Information" + * }, + * "data": { + * "name": "John Doe", + * "dob": "1980-05-15", + * "gender": "Male", + * "address": "123 Main Street, Anytown, USA", + * "email": "johndoe@example.com", + * "phone": "+1 555-123-4567", + * "nationality": "US", + * "passport_number": "AB1234567", + * "issue_date": "2010-02-20", + * "expiry_date": "2025-02-20", + * "bank_account_number": "1234567890", + * "bank_name": "Example Bank", + * "employer": "ABC Company", + * "occupation": "Software Engineer", + * "income": "$80,000 per year", + * "marital_status": "Single", + * "dependents": 0, + * "risk_level": "Low" + * } + * } + */ + KYCInformation: string; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + errorResponse: { + /** @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. + * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message. + * */ + statusCode?: string; + /** @description Error message text. */ + message?: string; + }; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + /** @enum {string} */ + bulkTransactionStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED"; + autoAcceptPartyOption: { + /** @enum {boolean} */ + enabled: false | true; + }; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + bulkPerTransferFeeLimit: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + autoAcceptQuote: { + /** @enum {boolean} */ + enabled: true | false; + perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; + }; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + bulkTransactionOptions: { + /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ + onlyValidateParty?: boolean; + autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; + /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ + autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ + synchronous?: boolean; + bulkExpiration: components["schemas"]["DateTime"]; + }; + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + kycInformation?: components["schemas"]["KYCInformation"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + /** @description Currencies in which the party can receive funds. */ + supportedCurrencies?: components["schemas"]["Currency"][]; + }; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + mojaloopError: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** @description This object represents a Mojaloop API error received at any time during the quote process */ + quoteError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + individualQuoteResult: { + quoteId: components["schemas"]["CorrelationId"]; + transferAmount?: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket?: components["schemas"]["IlpPacket"]; + condition?: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["quoteError"]; + }; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @example RESERVED + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** @description This object represents a Mojaloop API error received at any time during the transfer process */ + transferError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + individualTransferResult: { + transferId: components["schemas"]["CorrelationId"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + extensionList?: components["schemas"]["ExtensionList"]; + transferState?: components["schemas"]["TransferState"]; + lastError?: components["schemas"]["transferError"]; + }; + bulkTransactionIndividualTransferResult: { + transferId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + transactionId?: components["schemas"]["CorrelationId"]; + to?: components["schemas"]["Party"]; + /** @description Payer Loan reference */ + reference?: string; + amountType?: components["schemas"]["AmountType"]; + currency?: components["schemas"]["Currency"]; + amount?: components["schemas"]["Amount"]; + note?: components["schemas"]["Note"]; + quoteId?: components["schemas"]["CorrelationId"]; + quoteResponse?: components["schemas"]["individualQuoteResult"]; + fulfil?: components["schemas"]["individualTransferResult"]; + quoteExtensions?: components["schemas"]["ExtensionList"]; + transferExtensions?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["transferError"]; + }; + /** BulkTransactionResponse */ + bulkTransactionResponse: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + bulkHomeTransactionID: string; + bulkTransactionId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["bulkTransactionStatus"]; + options?: components["schemas"]["bulkTransactionOptions"]; + /** @description List of individual transfer result in a bulk transfer response. */ + individualTransferResults: components["schemas"]["bulkTransactionIndividualTransferResult"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** + * CurrencyConverter + * @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee. + * @enum {string} + */ + CurrencyConverter: "PAYER" | "PAYEE"; + /** + * FxRate + * @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. + */ + FxRate: { + sourceAmount: components["schemas"]["Money"] & unknown; + targetAmount: components["schemas"]["Money"] & unknown; + }; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * - U2F - U2F is a new addition isolated to Thirdparty stream. + * @example OTP + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE" | "U2F"; + /** + * FxMoney + * @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations. + */ + FxMoney: { + currency: components["schemas"]["Currency"]; + amount?: components["schemas"]["Amount"]; + }; + /** + * FxCharge + * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object. + */ + FxCharge: { + /** @description A description of the charge which is being levied. */ + chargeType: string; + sourceAmount?: components["schemas"]["Money"] & unknown; + targetAmount?: components["schemas"]["Money"] & unknown; + }; + /** + * FxConversion + * @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. + */ + FxConversion: { + conversionId: components["schemas"]["CorrelationId"] & unknown; + determiningTransferId?: components["schemas"]["CorrelationId"] & unknown; + initiatingFsp: components["schemas"]["FspId"] & unknown; + counterPartyFsp: components["schemas"]["FspId"] & unknown; + amountType: components["schemas"]["AmountType"] & unknown; + sourceAmount: components["schemas"]["FxMoney"] & unknown; + targetAmount: components["schemas"]["FxMoney"] & unknown; + expiration: components["schemas"]["DateTime"] & unknown; + /** @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. */ + charges?: components["schemas"]["FxCharge"][]; + extensionList?: components["schemas"]["ExtensionList"] & unknown; + }; + /** + * FxQuotesPostBackendRequest + * @description The object sent in the POST /fxQuotes request. + */ + FxQuotesPostBackendRequest: { + conversionRequestId: components["schemas"]["CorrelationId"] & unknown; + conversionTerms: components["schemas"]["FxConversion"] & unknown; + }; + /** + * FxQuotesPostBackendResponse + * @description The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester. + */ + FxQuotesPostBackendResponse: { + /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ + homeTransactionId?: string; + conversionTerms: components["schemas"]["FxConversion"] & unknown; + }; + commitRequestId: components["schemas"]["CorrelationId"] & unknown; + determiningTransferId: components["schemas"]["CorrelationId"] & unknown; + initiatingFsp: components["schemas"]["FspId"] & unknown; + counterPartyFsp: components["schemas"]["FspId"] & unknown; + sourceAmount: components["schemas"]["Money"] & unknown; + targetAmount: components["schemas"]["Money"] & unknown; + condition: components["schemas"]["IlpCondition"] & unknown; + /** + * FxTransfersPostBackendRequest + * @description The object sent in the POST /fxTransfers request. + */ + FxTransfersPostBackendRequest: { + /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ + homeTransactionId?: string; + commitRequestId: components["schemas"]["commitRequestId"]; + determiningTransferId?: components["schemas"]["determiningTransferId"]; + initiatingFsp: components["schemas"]["initiatingFsp"]; + counterPartyFsp: components["schemas"]["counterPartyFsp"]; + sourceAmount: components["schemas"]["sourceAmount"]; + targetAmount: components["schemas"]["targetAmount"]; + condition?: components["schemas"]["condition"]; + }; + fulfilment: components["schemas"]["IlpFulfilment"] & unknown; + completedTimestamp: components["schemas"]["DateTime"] & unknown; + conversionState: components["schemas"]["TransferState"] & unknown; + /** + * FxTransfersPostBackendResponse + * @description The object sent as a response for the POST /fxTransfers request. + */ + FxTransfersPostBackendResponse: { + /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ + homeTransactionId?: string; + fulfilment?: components["schemas"]["fulfilment"]; + completedTimestamp?: components["schemas"]["completedTimestamp"]; + conversionState: components["schemas"]["conversionState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * FxTransfersPutBackendRequest + * @description PUT /fxTransfers/{commitRequestId} object + */ + FxTransfersPutBackendRequest: { + /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ + homeTransactionId?: string; + fulfilment?: components["schemas"]["fulfilment"]; + completedTimestamp?: components["schemas"]["completedTimestamp"]; + conversionState: components["schemas"]["conversionState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; }; - /** @description An error occurred processing the request. */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Malformed or missing required headers or parameters. */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description An error occurred processing the request. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; }; - }; - parameters: { - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - idSubValue: string; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - idType: string; - /** @description The identifier value. */ - idValue: string; - transactionRequestId: components["schemas"]["transactionRequestId"]; - transferId: string; - /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ - bulkTransactionId: components["schemas"]["CorrelationId"]; - }; - requestBodies: never; - headers: never; - pathItems: never; + parameters: { + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + idSubValue: string; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: string; + /** @description The identifier value. */ + idValue: string; + transactionRequestId: components["schemas"]["transactionRequestId"]; + transferId: string; + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["schemas"]["CorrelationId"]; + }; + requestBodies: never; + headers: never; + pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - - /** Health check endpoint. */ - BackendHealthCheck: { - responses: { - /** @description Returns empty body if the service is running. */ - 200: { - content: never; - }; - }; - }; - /** Requests a bulk quote. */ - BackendBulkQuotesPost: { - /** @description Incoming request for a bulk quotation. */ - requestBody?: { - content: { - "application/json": components["schemas"]["bulkQuoteRequest"]; - }; - }; - responses: { - /** @description A response to the bulk quote request. */ - 200: { - content: { - "application/json": components["schemas"]["bulkQuoteResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** Requests information relating to a bulk quote identified by the specified identifier value. */ - BackendBulkQuotesGet: { - parameters: { - path: { - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested bulk quote. */ - 200: { - content: { - "application/json": components["schemas"]["bulkQuoteResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Callbacks for the bulk transaction request. - * @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. - */ - BackendBulkTransactionsPut: { - parameters: { - path: { - bulkTransactionId: components["parameters"]["bulkTransactionId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["bulkTransactionResponse"]; - }; - }; - responses: { - /** @description Bulk transaction information successfully amended. */ - 202: { - content: never; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Callback for the requestToPay request. - * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer. - */ - RequestToPayPut: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["requestToPayCallback"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** Execute bulk transfer of funds from an external account to internal accounts. */ - BackendBulkTransfersPost: { - /** @description An incoming bulk transfer request. */ - requestBody?: { - content: { - "application/json": components["schemas"]["bulkTransferRequest"]; - }; - }; - responses: { - /** @description The bulk transfer was accepted. */ - 200: { - content: { - "application/json": components["schemas"]["bulkTransferResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; - }; - }; - /** Requests information relating to a bulk transfer identified by the specified identifier value. */ - BackendBulkTransfersGet: { - parameters: { - path: { - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested bulk transfer. */ - 200: { - content: { - "application/json": components["schemas"]["bulkTransferResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** Requests OTP. */ - BackendOtpGet: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - responses: { - /** @description Response containing details of the OTP. */ - 200: { - content: { - "application/json": components["schemas"]["otpDetails"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located. - */ - BackendParticipantsGetByTypeAndID: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["participantsResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value. - * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located. - */ - BackendParticipantsGetByTypeIDAndSubId: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - idSubValue: components["parameters"]["idSubValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["participantsResponse"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; - }; - }; - /** - * Requests information relating to a transfer party identified by the specified identifier type and value. - * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`. - */ - BackendPartiesGetByTypeAndID: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - }; - }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["transferParty"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; + BackendHealthCheck: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns empty body if the service is running. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; }; - }; - /** - * Requests information relating to a transfer party identified by the specified identifier type, value and subId value. - * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`. - */ - BackendPartiesGetByTypeIdAndSubId: { - parameters: { - path: { - idType: components["parameters"]["idType"]; - idValue: components["parameters"]["idValue"]; - idSubValue: components["parameters"]["idSubValue"]; - }; + BackendBulkQuotesPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Incoming request for a bulk quotation. */ + requestBody?: { + content: { + "application/json": components["schemas"]["bulkQuoteRequest"]; + }; + }; + responses: { + /** @description A response to the bulk quote request. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Response containing details of the requested party. */ - 200: { - content: { - "application/json": components["schemas"]["transferParty"]; - }; - }; - 400: components["responses"]["400"]; - 404: components["responses"]["404"]; - 500: components["responses"]["500"]; + BackendBulkQuotesGet: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested bulk quote. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Requests a quote for the specified transfer. - * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction. - */ - BackendQuoteRequest: { - /** @description Request for a transfer quotation. */ - requestBody?: { - content: { - "application/json": components["schemas"]["quoteRequest"]; - }; + BackendBulkTransactionsPut: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["parameters"]["bulkTransactionId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["bulkTransactionResponse"]; + }; + }; + responses: { + /** @description Bulk transaction information successfully amended. */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description A response to the transfer quotation request. */ - 200: { - content: { - "application/json": components["schemas"]["quoteResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + RequestToPayPut: { + parameters: { + query?: never; + header?: never; + path: { + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["requestToPayCallback"]; + }; + }; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** Transaction request that supports pull based transfers. */ - BackendTransactionRequest: { - /** @description Request for Transaction Request. */ - requestBody?: { - content: { - "application/json": components["schemas"]["transactionRequest"]; - }; + BackendBulkTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description An incoming bulk transfer request. */ + requestBody?: { + content: { + "application/json": components["schemas"]["bulkTransferRequest"]; + }; + }; + responses: { + /** @description The bulk transfer was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description A response to the transfer transaction request. */ - 200: { - content: { - "application/json": components["schemas"]["transactionRequestResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + BackendBulkTransfersGet: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested bulk transfer. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Transfers funds from an external account to an internal account. - * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party. - */ - BackendTransfersPost: { - /** @description An incoming transfer request. */ - requestBody?: { - content: { - "application/json": components["schemas"]["transferRequest"]; - }; + BackendOtpGet: { + parameters: { + query?: never; + header?: never; + path: { + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the OTP. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["otpDetails"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description The transfer was accepted. */ - 200: { - content: { - "application/json": components["schemas"]["transferResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + BackendParticipantsGetByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["participantsResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Retrieves information for a specific transfer. - * @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. - */ - BackendTransfersGet: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; + BackendParticipantsGetByTypeIDAndSubId: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + idSubValue: components["parameters"]["idSubValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["participantsResponse"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description The transfer was accepted. */ - 200: { - content: { - "application/json": components["schemas"]["transferDetailsResponse"]; + BackendPartiesGetByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferParty"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; }; - }; - 500: components["responses"]["500"]; }; - }; - /** - * Receive notification for a specific transfer. - * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee. - */ - BackendTransfersPut: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; + BackendPartiesGetByTypeIdAndSubId: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + idType: components["parameters"]["idType"]; + /** @description The identifier value. */ + idValue: components["parameters"]["idValue"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + idSubValue: components["parameters"]["idSubValue"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response containing details of the requested party. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferParty"]; + }; + }; + 400: components["responses"]["400"]; + 404: components["responses"]["404"]; + 500: components["responses"]["500"]; + }; }; - /** @description An incoming notification for fulfiled transfer. */ - requestBody?: { - content: { - "application/json": components["schemas"]["fulfilNotification"]; - }; + BackendQuoteRequest: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Request for a transfer quotation. */ + requestBody?: { + content: { + "application/json": components["schemas"]["quoteRequest"]; + }; + }; + responses: { + /** @description A response to the transfer quotation request. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["quoteResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description The notification was accepted. */ - 200: { - content: never; - }; - 500: components["responses"]["500"]; + BackendTransactionRequest: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Request for Transaction Request. */ + requestBody?: { + content: { + "application/json": components["schemas"]["transactionRequest"]; + }; + }; + responses: { + /** @description A response to the transfer transaction request. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transactionRequestResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Calculate FX quote - * @description The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion. - */ - FxQuotesPost: { - /** @description Details of the FX quote request. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxQuotesPostBackendRequest"]; - }; + BackendTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description An incoming transfer request. */ + requestBody?: { + content: { + "application/json": components["schemas"]["transferRequest"]; + }; + }; + responses: { + /** @description The transfer was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Successful response. */ - 200: { - content: { - "application/json": components["schemas"]["FxQuotesPostBackendResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + BackendTransfersGet: { + parameters: { + query?: never; + header?: never; + path: { + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The transfer was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferDetailsResponse"]; + }; + }; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Perform FX transfer - * @description The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion. - */ - FxTransfersPost: { - /** @description Details of the FX transfer request. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxTransfersPostBackendRequest"]; - }; + BackendTransfersPut: { + parameters: { + query?: never; + header?: never; + path: { + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + /** @description An incoming notification for fulfiled transfer. */ + requestBody?: { + content: { + "application/json": components["schemas"]["fulfilNotification"]; + }; + }; + responses: { + /** @description The notification was accepted. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Successful response. */ - 200: { - content: { - "application/json": components["schemas"]["FxTransfersPostBackendResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + FxQuotesPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Details of the FX quote request. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxQuotesPostBackendRequest"]; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["FxQuotesPostBackendResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * FX Commit Notification - * @description The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion. - */ - FxTransfersById: { - /** @description Status of the FX transfer. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxTransfersPutBackendRequest"]; - }; + FxTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Details of the FX transfer request. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersPostBackendRequest"]; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["FxTransfersPostBackendResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + FxTransfersById: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Status of the FX transfer. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersPutBackendRequest"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; } diff --git a/src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts b/src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts index 06a06d6d..d3632006 100644 --- a/src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts +++ b/src/sdk-scheme-adapter/v2_1_0/outbound/openapi.ts @@ -3,1903 +3,2406 @@ * Do not make direct changes to the file. */ - export interface paths { - "/": { - /** - * Health check endpoint - * @description This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening. - */ - get: { - responses: { - /** @description Returns empty body if the scheme adapter outbound transfers service is running. */ - 200: { - content: never; - }; - }; - }; - }; - "/accounts": { - /** - * Create accounts on the Account Lookup Service - * @description The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities. - * - * Caller DFSP is used as the account source FSP information - */ - post: { - /** @description Identities list request body */ - requestBody: { - content: { - "application/json": components["schemas"]["accountsRequest"]; - }; - }; - responses: { - 200: components["responses"]["accountsCreationCompleted"]; - 400: components["responses"]["accountsCreationError"]; - 500: components["responses"]["accountsCreationError"]; - 504: components["responses"]["accountsCreationTimeout"]; - }; - }; - }; - "/bulkQuotes": { - /** - * Request bulk quotes for the provided financial transactions - * @description The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP. - */ - post: { - /** @description Bulk quote request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkQuoteRequest"]; - }; - }; - responses: { - 200: components["responses"]["bulkQuoteSuccess"]; - 400: components["responses"]["bulkQuoteBadRequest"]; - 500: components["responses"]["bulkQuoteServerError"]; - 504: components["responses"]["bulkQuoteTimeout"]; - }; - }; - }; - "/bulkQuotes/{bulkQuoteId}": { - /** - * Retrieves information for a specific bulk quote - * @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. - */ - get: { - parameters: { - path: { - bulkQuoteId: components["parameters"]["bulkQuoteId"]; - }; - }; - responses: { - /** @description Bulk quote information successfully retrieved */ - 200: { - content: { - "application/json": components["schemas"]["bulkQuoteStatusResponse"]; - }; + "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description An error occurred processing the bulk quote */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + /** + * Health check endpoint + * @description This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening. + */ + get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns empty body if the scheme adapter outbound transfers service is running. */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; }; - }; - }; - }; - "/bulkTransactions": { - /** - * Sends money from one account to multiple accounts - * @description The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP. - */ - post: { - /** @description Bulk transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkTransactionRequest"]; - }; - }; - responses: { - 202: components["responses"]["bulkTransactionAccepted"]; - 400: components["responses"]["bulkTransferBadRequest"]; - 500: components["responses"]["errorResponse"]; - }; - }; - }; - "/bulkTransactions/{bulkTransactionId}": { - /** - * Amends the bulk transaction request - * @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. - */ - put: { - parameters: { - path: { - bulkTransactionId: components["parameters"]["bulkTransactionId"]; - }; - }; - /** @description Bulk transaction request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkTransactionContinuationAcceptParty"] | components["schemas"]["bulkTransactionContinuationAcceptQuote"]; - }; - }; - responses: { - /** @description Bulk transaction information successfully amended */ - 202: { - content: never; - }; - 400: components["responses"]["bulkTransactionPutBadRequest"]; - /** @description An error occurred processing the bulk transaction */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - }; - }; - }; - "/bulkTransfers": { - /** - * Sends money from one account to multiple accounts - * @description The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP. - */ - post: { - /** @description Bulk transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["bulkTransferRequest"]; - }; - }; - responses: { - 200: components["responses"]["bulkTransferSuccess"]; - 400: components["responses"]["bulkTransferBadRequest"]; - 500: components["responses"]["errorResponse"]; - }; - }; - }; - "/bulkTransfers/{bulkTransferId}": { - /** - * Retrieves information for a specific bulk transfer - * @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. - */ - get: { - parameters: { - path: { - bulkTransferId: components["parameters"]["bulkTransferId"]; - }; - }; - responses: { - /** @description Bulk transfer information successfully retrieved */ - 200: { - content: { - "application/json": components["schemas"]["bulkTransferStatusResponse"]; - }; - }; - /** @description An error occurred processing the bulk transfer */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + get?: never; + put?: never; + /** + * Create accounts on the Account Lookup Service + * @description The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities. + * + * Caller DFSP is used as the account source FSP information + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Identities list request body */ + requestBody: { + content: { + "application/json": components["schemas"]["accountsRequest"]; + }; + }; + responses: { + 200: components["responses"]["accountsCreationCompleted"]; + 400: components["responses"]["accountsCreationError"]; + 500: components["responses"]["accountsCreationError"]; + 504: components["responses"]["accountsCreationTimeout"]; + }; }; - }; - }; - }; - "/parties/{Type}/{ID}": { - /** - * PartiesByTypeAndID - * @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). - */ - get: operations["PartiesByTypeAndID"]; - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/parties/{Type}/{ID}/{SubId}": { - /** - * PartiesSubIdByTypeAndID - * @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). - */ - get: operations["PartiesSubIdByTypeAndID"]; - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - }; - "/quotes": { - /** - * Quotes endpoint - * @description is used to request quotes from other DFSP - */ - post: operations["QuotesPost"]; - }; - "/requestToPay": { - /** - * Receiver requesting funds from Sender - * @description The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender. - * The underlying API has two stages: - * - * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. - * 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee. - */ - post: { - /** @description RequestToPay request body */ - requestBody: { - content: { - "application/json": components["schemas"]["requestToPayRequest"]; - }; - }; - responses: { - 200: components["responses"]["requestToPaySuccess"]; - }; - }; - }; - "/requestToPay/{transactionRequestId}": { - /** - * Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information - * @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. - * The request body should contain the "acceptParty" property set to `true` as required to continue the transfer. - * See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer. - */ - put: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["transferContinuationAcceptParty"]; - }; - }; - responses: { - 200: components["responses"]["requestToPaySuccess"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/requestToPayTransfer": { - /** - * Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay. - * @description The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP. - * The underlying Mojaloop API has three stages for money transfer: - * - * 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. - * 2. Authorization. This facilitates getting OTP from payee DFSP. - * 3. Transfer. The enactment of the previously agreed "contract" - * - * This method has several modes of operation. - * - 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. - * 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. - * The scheme adapter will then proceed with the transfer state. - * - * - 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. - * 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. - * The scheme adapter will then proceed with the transfer state. - * - * 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. - * - * 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... - */ - post: { - /** @description Request To Pay Transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["requestToPayTransferRequest"]; - }; - }; - responses: { - 200: components["responses"]["requestToPayTransferSuccess"]; - 400: components["responses"]["requestToPayTransferBadRequest"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/requestToPayTransfer/{transactionRequestId}": { - /** - * Continues a transfer that has paused at the otp stage in order to accept or reject quote - * @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. - * - * The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer. - * - * See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer. - */ - put: { - parameters: { - path: { - transactionRequestId: components["parameters"]["transactionRequestId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptOTP"]; - }; - }; - responses: { - 200: components["responses"]["transferSuccess"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/simpleTransfers": { - /** - * Simple Transfers endpoint - * @description is used to request a transfer - */ - post: operations["SimpleTransfersPost"]; - }; - "/transfers": { - /** - * Sends money from one account to another - * @description The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP. - * The underlying Mojaloop API has three stages for money transfer: - * - * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. - * 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. - * 3. Transfer. The enactment of the previously agreed "contract" - * - * This method has several modes of operation. - * - 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. - * 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. - * The scheme adapter will then proceed with quotation stage... - * - * - 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. - * 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. - * The scheme adapter will then proceed with the transfer state. - * - * 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. - * - * 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... - */ - post: { - /** @description Transfer request body */ - requestBody: { - content: { - "application/json": components["schemas"]["transferRequest"]; - }; - }; - responses: { - 200: components["responses"]["transferSuccess"]; - 400: components["responses"]["transferBadRequest"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; - }; - }; - "/transfers/{transferId}": { - /** - * Retrieves information for a specific transfer - * @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. - */ - get: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; - }; - responses: { - /** @description Transfer information successfully retrieved */ - 200: { - content: { - "application/json": components["schemas"]["transferStatusResponse"]; - }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description An error occurred processing the transfer */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; + get?: never; + put?: never; + /** + * Request bulk quotes for the provided financial transactions + * @description The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Bulk quote request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkQuoteRequest"]; + }; + }; + responses: { + 200: components["responses"]["bulkQuoteSuccess"]; + 400: components["responses"]["bulkQuoteBadRequest"]; + 500: components["responses"]["bulkQuoteServerError"]; + 504: components["responses"]["bulkQuoteTimeout"]; + }; }; - }; - }; - /** - * Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote and/or conversion - * @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. - * - * The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion" property set to `true` as required to continue the transfer. - * - * See the description of the `POST /transfers` HTTP method for more information on modes of transfer. - */ - put: { - parameters: { - path: { - transferId: components["parameters"]["transferId"]; - }; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["transferContinuationAcceptParty"] | components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptConversion"]; - }; - }; - responses: { - 200: components["responses"]["transferSuccess"]; - 500: components["responses"]["transferServerError"]; - 504: components["responses"]["transferTimeout"]; - }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkQuotes/{bulkQuoteId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific bulk quote + * @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. + */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkQuoteId: components["parameters"]["bulkQuoteId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Bulk quote information successfully retrieved */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteStatusResponse"]; + }; + }; + /** @description An error occurred processing the bulk quote */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Sends money from one account to multiple accounts + * @description The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Bulk transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkTransactionRequest"]; + }; + }; + responses: { + 202: components["responses"]["bulkTransactionAccepted"]; + 400: components["responses"]["bulkTransferBadRequest"]; + 500: components["responses"]["errorResponse"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransactions/{bulkTransactionId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Amends the bulk transaction request + * @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. + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["parameters"]["bulkTransactionId"]; + }; + cookie?: never; + }; + /** @description Bulk transaction request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkTransactionContinuationAcceptParty"] | components["schemas"]["bulkTransactionContinuationAcceptQuote"]; + }; + }; + responses: { + /** @description Bulk transaction information successfully amended */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bulkTransactionPutBadRequest"]; + /** @description An error occurred processing the bulk transaction */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Sends money from one account to multiple accounts + * @description The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Bulk transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["bulkTransferRequest"]; + }; + }; + responses: { + 200: components["responses"]["bulkTransferSuccess"]; + 400: components["responses"]["bulkTransferBadRequest"]; + 500: components["responses"]["errorResponse"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/bulkTransfers/{bulkTransferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific bulk transfer + * @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. + */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkTransferId: components["parameters"]["bulkTransferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Bulk transfer information successfully retrieved */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferStatusResponse"]; + }; + }; + /** @description An error occurred processing the bulk transfer */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * PartiesByTypeAndID + * @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). + */ + get: operations["PartiesByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/parties/{Type}/{ID}/{SubId}": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + /** + * PartiesSubIdByTypeAndID + * @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). + */ + get: operations["PartiesSubIdByTypeAndID"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/quotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Quotes endpoint + * @description is used to request quotes from other DFSP + */ + post: operations["QuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPay": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Receiver requesting funds from Sender + * @description The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender. + * The underlying API has two stages: + * + * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. + * 2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee. + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description RequestToPay request body */ + requestBody: { + content: { + "application/json": components["schemas"]["requestToPayRequest"]; + }; + }; + responses: { + 200: components["responses"]["requestToPaySuccess"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPay/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information + * @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. + * The request body should contain the "acceptParty" property set to `true` as required to continue the transfer. + * See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer. + * + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["transferContinuationAcceptParty"]; + }; + }; + responses: { + 200: components["responses"]["requestToPaySuccess"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPayTransfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay. + * @description The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP. + * The underlying Mojaloop API has three stages for money transfer: + * + * 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. + * 2. Authorization. This facilitates getting OTP from payee DFSP. + * 3. Transfer. The enactment of the previously agreed "contract" + * + * This method has several modes of operation. + * - 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. + * 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. + * The scheme adapter will then proceed with the transfer state. + * + * - 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. + * 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. + * The scheme adapter will then proceed with the transfer state. + * + * 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. + * + * 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... + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Request To Pay Transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["requestToPayTransferRequest"]; + }; + }; + responses: { + 200: components["responses"]["requestToPayTransferSuccess"]; + 400: components["responses"]["requestToPayTransferBadRequest"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/requestToPayTransfer/{transactionRequestId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Continues a transfer that has paused at the otp stage in order to accept or reject quote + * @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. + * + * The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer. + * + * See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer. + * + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ + transactionRequestId: components["parameters"]["transactionRequestId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptOTP"]; + }; + }; + responses: { + 200: components["responses"]["transferSuccess"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/simpleTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Simple Transfers endpoint + * @description is used to request a transfer + */ + post: operations["SimpleTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Sends money from one account to another + * @description The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP. + * The underlying Mojaloop API has three stages for money transfer: + * + * 1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement. + * 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. + * 3. Transfer. The enactment of the previously agreed "contract" + * + * This method has several modes of operation. + * - 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. + * 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. + * The scheme adapter will then proceed with quotation stage... + * + * - 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. + * 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. + * The scheme adapter will then proceed with the transfer state. + * + * 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. + * + * 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... + * + */ + post: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Transfer request body */ + requestBody: { + content: { + "application/json": components["schemas"]["transferRequest"]; + }; + }; + responses: { + 200: components["responses"]["transferSuccess"]; + 400: components["responses"]["transferBadRequest"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/transfers/{transferId}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieves information for a specific transfer + * @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. + */ + get: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Transfer information successfully retrieved */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferStatusResponse"]; + }; + }; + /** @description An error occurred processing the transfer */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + }; + }; + /** + * Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote and/or conversion + * @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. + * + * The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion" property set to `true` as required to continue the transfer. + * + * See the description of the `POST /transfers` HTTP method for more information on modes of transfer. + * + */ + put: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ + transferId: components["parameters"]["transferId"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["transferContinuationAcceptParty"] | components["schemas"]["transferContinuationAcceptQuote"] | components["schemas"]["transferContinuationAcceptConversion"]; + }; + }; + responses: { + 200: components["responses"]["transferSuccess"]; + 500: components["responses"]["transferServerError"]; + 504: components["responses"]["transferTimeout"]; + }; + }; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/services/FXP": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Obtain a list of the DFSPs in the scheme who provide FXP service + * @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services. + */ + get: operations["ServicesFXPGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/services/FXP/{SourceCurrency}/{TargetCurrency}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Obtain a list of the DFSPs in the scheme who provide FXP service + * @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. + */ + get: operations["ServicesFXPSourceCurrencyTargetCurrencyGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxQuotes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Calculate FX quote + * @description The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion. + */ + post: operations["FxQuotesPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/fxTransfers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Perform FX transfer + * @description The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion. + */ + post: operations["FxTransfersPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - }; - "/services/FXP": { - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services. - */ - get: operations["ServicesFXPGet"]; - }; - "/services/FXP/{SourceCurrency}/{TargetCurrency}": { - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @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. - */ - get: operations["ServicesFXPSourceCurrencyTargetCurrencyGet"]; - }; - "/fxQuotes": { - /** - * Calculate FX quote - * @description The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion. - */ - post: operations["FxQuotesPost"]; - }; - "/fxTransfers": { - /** - * Perform FX transfer - * @description The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion. - */ - post: operations["FxTransfersPost"]; - }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - accountsRequest: { - idType: components["schemas"]["PartyIdType"]; - idValue: components["schemas"]["PartyIdentifier"]; - idSubValue?: components["schemas"]["PartySubIdOrType"]; - currency: components["schemas"]["Currency"]; - }[]; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - errorResponse: { - /** - * @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. - * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message. - */ - statusCode?: string; - /** @description Error message text. */ - message?: string; - }; - accountCreationStatus: { - idType: components["schemas"]["PartyIdType"]; - idValue: components["schemas"]["PartyIdentifier"]; - idSubValue?: components["schemas"]["PartySubIdOrType"]; - error?: components["schemas"]["errorResponse"]; - }[]; - /** @enum {string} */ - accountsCreationState: "ERROR_OCCURRED" | "COMPLETED"; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - mojaloopError: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** @description This object represents a Mojaloop API error received at any time during the transfer process */ - transferError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - accountsResponse: { - modelId?: components["schemas"]["CorrelationId"]; - accounts: components["schemas"]["accountsRequest"]; - response?: components["schemas"]["accountCreationStatus"]; - currentState?: components["schemas"]["accountsCreationState"]; - lastError?: components["schemas"]["transferError"]; - postAccountsResponse?: { - body: Record; - headers?: Record; - }; - }; - errorAccountsResponse: components["schemas"]["errorResponse"] & { - executionState: components["schemas"]["accountsResponse"]; - }; - /** - * TransactionInitiatorType - * @description Below are the allowed values for the enumeration. - * - CONSUMER - Consumer is the initiator of the transaction. - * - AGENT - Agent is the initiator of the transaction. - * - BUSINESS - Business is the initiator of the transaction. - * - DEVICE - Device is the initiator of the transaction. - * @example CONSUMER - * @enum {string} - */ - TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** - * Name - * @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. - * - * 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 ( ). - * - * **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. - */ - Name: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** - * KYCInformation - * @description KYC information for the party in a form mandated by an individual scheme. - * @example { - * "metadata": { - * "format": "JSON", - * "version": "1.0", - * "description": "Data containing KYC Information" - * }, - * "data": { - * "name": "John Doe", - * "dob": "1980-05-15", - * "gender": "Male", - * "address": "123 Main Street, Anytown, USA", - * "email": "johndoe@example.com", - * "phone": "+1 555-123-4567", - * "nationality": "US", - * "passport_number": "AB1234567", - * "issue_date": "2010-02-20", - * "expiry_date": "2025-02-20", - * "bank_account_number": "1234567890", - * "bank_name": "Example Bank", - * "employer": "ABC Company", - * "occupation": "Software Engineer", - * "income": "$80,000 per year", - * "marital_status": "Single", - * "dependents": 0, - * "risk_level": "Low" - * } - * } - */ - KYCInformation: string; - extensionListEmptiable: components["schemas"]["Extension"][]; - transferParty: { - type?: components["schemas"]["TransactionInitiatorType"]; - idType: components["schemas"]["PartyIdType"]; - idValue: components["schemas"]["PartyIdentifier"]; - idSubValue?: components["schemas"]["PartySubIdOrType"]; - displayName?: components["schemas"]["Name"]; - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - fspId?: components["schemas"]["FspId"]; - /** @description Currencies in which the party can receive funds. */ - supportedCurrencies?: components["schemas"]["Currency"][]; - kycInformation?: components["schemas"]["KYCInformation"]; - extensionList?: components["schemas"]["extensionListEmptiable"]; - }; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - /** - * transferTransactionType - * @description Type of transaction. - * @enum {string} - */ - transferTransactionType: "TRANSFER"; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * IndividualQuote - * @description Data model for the complex type 'individualQuote'. - */ - individualQuote: { - quoteId: components["schemas"]["CorrelationId"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - note?: components["schemas"]["Note"]; - extensions?: components["schemas"]["ExtensionList"]; - }; - bulkQuoteRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - bulkQuoteId?: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - /** @description List of individual quotes in a bulk quote. */ - individualQuotes: components["schemas"]["individualQuote"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - /** @enum {string} */ - bulkTransferStatus: "ERROR_OCCURRED" | "COMPLETED"; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** @description This object represents a Mojaloop API error received at any time during the quote process */ - quoteError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - individualQuoteResult: { - quoteId: components["schemas"]["CorrelationId"]; - transferAmount?: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket?: components["schemas"]["IlpPacket"]; - condition?: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["quoteError"]; - }; - bulkQuoteResponse: { - bulkQuoteId: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId?: string; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - currentState: components["schemas"]["bulkTransferStatus"]; - /** @description List of individualQuoteResults in a bulk transfer response. */ - individualQuoteResults: components["schemas"]["individualQuoteResult"][]; - }; - bulkQuoteErrorResponse: components["schemas"]["errorResponse"] & { - bulkQuoteState: components["schemas"]["bulkQuoteResponse"]; - }; - /** @enum {string} */ - bulkQuoteStatus: "ERROR_OCCURRED" | "COMPLETED"; - bulkQuoteStatusResponse: { - bulkQuoteId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["bulkQuoteStatus"]; - individualQuotes: components["schemas"]["individualQuote"][]; - }; - autoAcceptPartyOption: { - /** @enum {boolean} */ - enabled: false | true; - }; - bulkPerTransferFeeLimit: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - autoAcceptQuote: { - /** @enum {boolean} */ - enabled: true | false; - perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; - }; - bulkTransactionOptions: { - /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ - onlyValidateParty?: boolean; - autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; - /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ - autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ - synchronous?: boolean; - bulkExpiration: components["schemas"]["DateTime"]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - kycInformation?: components["schemas"]["KYCInformation"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - /** @description Currencies in which the party can receive funds. */ - supportedCurrencies?: components["schemas"]["Currency"][]; - }; - /** - * BulkTransactionIndividualTransfer - * @description Data model for the complex type 'bulkTransactionIndividualTransfer'. - */ - bulkTransactionIndividualTransfer: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - to: components["schemas"]["Party"]; - /** @description Payer Loan reference */ - reference?: string; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - note?: components["schemas"]["Note"]; - quoteExtensions?: components["schemas"]["ExtensionList"]; - transferExtensions?: components["schemas"]["ExtensionList"]; - lastError?: components["schemas"]["transferError"]; - }; - bulkTransactionRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - bulkHomeTransactionID: string; - bulkTransactionId: components["schemas"]["CorrelationId"]; - options: components["schemas"]["bulkTransactionOptions"]; - from: components["schemas"]["Party"]; - /** @description List of individual transfers in a bulk transfer. */ - individualTransfers: components["schemas"]["bulkTransactionIndividualTransfer"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** - * TransferState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Next ledger has received the transfer. - * - RESERVED - Next ledger has reserved the transfer. - * - COMMITTED - Next ledger has successfully performed the transfer. - * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. - * @example RESERVED - * @enum {string} - */ - TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - individualTransferResult: { - transferId: components["schemas"]["CorrelationId"]; - fulfilment?: components["schemas"]["IlpFulfilment"]; - extensionList?: components["schemas"]["ExtensionList"]; - transferState?: components["schemas"]["TransferState"]; - lastError?: components["schemas"]["transferError"]; - }; - bulkTransferResponse: { - bulkTransferId: components["schemas"]["CorrelationId"]; - bulkQuoteId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId?: string; - bulkTransferState?: components["schemas"]["TransferState"]; - completedTimestamp?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - currentState: components["schemas"]["bulkTransferStatus"]; - /** @description List of individual transfer result in a bulk transfer response. */ - individualTransferResults: components["schemas"]["individualTransferResult"][]; - }; - bulkTransferErrorResponse: components["schemas"]["errorResponse"] & { - bulkTransferState: components["schemas"]["bulkTransferResponse"]; - }; - /** @description Data model for the 'individualTransfer' while accepting party or quote. */ - bulkTransactionIndividualTransferAccept: { - transferId: components["schemas"]["CorrelationId"]; - }; - transferContinuationAcceptParty: { - /** @enum {boolean} */ - acceptParty: true | false; - }; - /** @description The object sent back as confirmation of payee parties when autoAcceptParty is false. */ - bulkTransactionContinuationAcceptParty: { - /** @description List of individual transfers in a bulk transfer with accept party information. */ - individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptParty"])[]; - }; - transferContinuationAcceptQuote: { - /** @enum {boolean} */ - acceptQuote: true | false; - }; - /** @description The object sent back as confirmation of quotes when autoAcceptQuotes is false. */ - bulkTransactionContinuationAcceptQuote: { - /** @description List of individual transfers in a bulk transfer. */ - individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptQuote"])[]; - }; - /** @description This object represents a Mojaloop API error received at any time during the party discovery process */ - partyError: { - /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ - httpStatusCode?: number; - mojaloopError?: components["schemas"]["mojaloopError"]; - }; - bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & ({ - bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"]; - }); - bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & ({ - bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"]; - }); - /** - * IndividualTransfer - * @description Data model for the complex type 'individualTransfer'. - */ - individualTransfer: { - transferId: components["schemas"]["CorrelationId"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType?: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - note?: components["schemas"]["Note"]; - extensions?: components["schemas"]["ExtensionList"]; - }; - bulkTransferRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - bulkTransferId: components["schemas"]["CorrelationId"]; - bulkQuoteId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - /** @description List of individual transfers in a bulk transfer. */ - individualTransfers: components["schemas"]["individualTransfer"][]; - extensions?: components["schemas"]["ExtensionList"]; - }; - /** @description A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer */ - individualTransferFulfilment: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - bulkTransferStatusResponse: { - bulkTransferId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["bulkTransferStatus"]; - fulfils: components["schemas"]["individualTransferFulfilment"][]; - }; - /** @enum {string} */ - async2SyncCurrentState: "WAITING_FOR_ACTION" | "COMPLETED" | "ERROR_OCCURRED"; - /** - * partiesByIdResponse - * @description GET /parties/{Type}/{ID} response object - */ - partiesByIdResponse: { - party: { - body: components["schemas"]["Party"]; - headers: Record; - }; - currentState: components["schemas"]["async2SyncCurrentState"]; - }; - /** - * TransactionScenario - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. - * - 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. - * - REFUND - Used for performing a refund of transaction. - * @example DEPOSIT - * @enum {string} - */ - TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; - /** - * TransactionInitiator - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * @example PAYEE - * @enum {string} - */ - TransactionInitiator: "PAYER" | "PAYEE"; - /** - * RefundReason - * @description Reason for the refund. - * @example Free text indicating reason for the refund. - */ - RefundReason: string; - /** - * Refund - * @description Data model for the complex type Refund. - */ - Refund: { - originalTransactionId: components["schemas"]["CorrelationId"]; - refundReason?: components["schemas"]["RefundReason"]; - }; - /** - * BalanceOfPayments - * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. - * @example 123 - */ - BalanceOfPayments: string; - /** - * TransactionType - * @description Data model for the complex type TransactionType. - */ - TransactionType: { - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - refundInfo?: components["schemas"]["Refund"]; - balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; - }; - /** - * CurrencyConverter - * @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee. - * @enum {string} - */ - CurrencyConverter: "PAYER" | "PAYEE"; - /** - * FxRate - * @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. - */ - FxRate: { - sourceAmount: components["schemas"]["Money"]; - targetAmount: components["schemas"]["Money"]; - }; - /** - * QuotesPostRequest - * @description The object sent in the POST /quotes request. - */ - QuotesPostRequest: { - quoteId: components["schemas"]["CorrelationId"]; - transactionId: components["schemas"]["CorrelationId"]; - transactionRequestId?: components["schemas"]["CorrelationId"]; - payee: components["schemas"]["Party"]; - payer: components["schemas"]["Party"]; - amountType: components["schemas"]["AmountType"]; - amount: components["schemas"]["Money"]; - fees?: components["schemas"]["Money"]; - transactionType: components["schemas"]["TransactionType"]; - converter?: components["schemas"]["CurrencyConverter"]; - currencyConversion?: components["schemas"]["FxRate"]; - geoCode?: components["schemas"]["GeoCode"]; - note?: components["schemas"]["Note"]; - expiration?: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** simpleQuotesPostRequest */ - simpleQuotesPostRequest: { - fspId: components["schemas"]["FspId"]; - quotesPostRequest: components["schemas"]["QuotesPostRequest"]; - }; - /** QuotesPostResponse */ - quotesPostResponse: { - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - quotes: { - body: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - /** - * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - headers: Record; - }; - currentState: components["schemas"]["async2SyncCurrentState"]; - }; - errorQuotesResponse: components["schemas"]["errorResponse"] & Record; - /** - * AuthenticationType - * @description Below are the allowed values for the enumeration AuthenticationType. - * - OTP - One-time password generated by the Payer FSP. - * - QRCODE - QR code used as One Time Password. - * - U2F - U2F is a new addition isolated to Thirdparty stream. - * @example OTP - * @enum {string} - */ - AuthenticationType: "OTP" | "QRCODE" | "U2F"; - requestToPayRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId: string; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - }; - /** @enum {string} */ - requestToPayStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "COMPLETED"; - /** - * getPartiesResponse - * @description The object sent in the GET /parties/{Type}/{ID} callback. - */ - getPartiesResponse: { - body: components["schemas"]["Party"]; - headers: Record; - }; - /** - * TransactionRequestState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. - * - PENDING - Payer FSP has sent the transaction request to the Payer. - * - ACCEPTED - Payer has approved the transaction. - * - REJECTED - Payer has rejected the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * TransactionRequestResponse - * @description The object sent in the PUT /transactionRequests/{ID} callback. - */ - TransactionRequestResponse: { - body: { - transactionId?: components["schemas"]["CorrelationId"]; - transactionRequestState: components["schemas"]["TransactionRequestState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - headers: Record; - }; - requestToPayResponse: { - transactionRequestId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - currentState: components["schemas"]["requestToPayStatus"]; - getPartiesResponse?: components["schemas"]["getPartiesResponse"]; - transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"]; - lastError?: components["schemas"]["transferError"]; - }; - /** @enum {string} */ - transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "WAITING_FOR_CONVERSION_ACCEPTANCE" | "COMPLETED"; - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - QuotesIDPutResponse: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - expiration: components["schemas"]["DateTime"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxMoney - * @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations. - */ - FxMoney: { - currency: components["schemas"]["Currency"]; - amount?: components["schemas"]["Amount"]; - }; - /** - * FxCharge - * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object. - */ - FxCharge: { - /** @description A description of the charge which is being levied. */ - chargeType: string; - sourceAmount?: components["schemas"]["Money"]; - targetAmount?: components["schemas"]["Money"]; - }; - /** - * FxConversion - * @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. - */ - FxConversion: { - conversionId: components["schemas"]["CorrelationId"]; - determiningTransferId?: components["schemas"]["CorrelationId"]; - initiatingFsp: components["schemas"]["FspId"]; - counterPartyFsp: components["schemas"]["FspId"]; - amountType: components["schemas"]["AmountType"]; - sourceAmount: components["schemas"]["FxMoney"]; - targetAmount: components["schemas"]["FxMoney"]; - expiration: components["schemas"]["DateTime"]; - /** @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. */ - charges?: components["schemas"]["FxCharge"][]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * FxQuotesPostOutboundResponse - * @description The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester. - */ - FxQuotesPostOutboundResponse: { - /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ - homeTransactionId?: string; - condition?: components["schemas"]["IlpCondition"]; - conversionTerms: components["schemas"]["FxConversion"]; - }; - /** - * TransfersIDPutResponse - * @description The object sent in the PUT /transfers/{ID} callback. - */ - TransfersIDPutResponse: { - fulfilment?: components["schemas"]["IlpFulfilment"]; - completedTimestamp?: components["schemas"]["DateTime"]; - transferState: components["schemas"]["TransferState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - transferResponse: { - transferId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - note?: components["schemas"]["Note"]; - currentState?: components["schemas"]["transferStatus"]; - quoteId?: components["schemas"]["CorrelationId"]; - getPartiesResponse?: { - body: Record; - headers?: Record; - }; - quoteResponse?: { - body: components["schemas"]["QuotesIDPutResponse"]; - headers?: Record; - }; - /** @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. */ - quoteResponseSource?: string; - conversionRequestId?: components["schemas"]["CorrelationId"]; - fxQuotesResponse?: { - body: components["schemas"]["FxQuotesPostOutboundResponse"]; - headers?: Record; - }; - /** @description FXPID of the entity that supplied the fxQuotes response. */ - fxQuotesResponseSource?: string; - fulfil?: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers?: Record; - }; - lastError?: components["schemas"]["transferError"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - }; - errorTransferResponse: components["schemas"]["errorResponse"] & { - transferState: components["schemas"]["transferResponse"]; - }; - requestToPayTransferRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId: string; - transactionRequestId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - note?: components["schemas"]["Note"]; - authenticationType?: components["schemas"]["AuthenticationType"]; - }; - /** - * AuthenticationValue - * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. - */ - AuthenticationValue: string | { - /** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. */ - pinValue: string; - /** - * Integer - * @description Sequential counter used for cloning detection. Present only for U2F authentication. - */ - counter: string; - }; - /** - * AuthenticationInfo - * @description Data model for the complex type AuthenticationInfo. - */ - AuthenticationInfo: { - authentication: components["schemas"]["AuthenticationType"]; - authenticationValue: components["schemas"]["AuthenticationValue"]; - }; - /** - * AuthorizationResponseType - * @description Below are the allowed values for the enumeration. - * - ENTERED - Consumer entered the authentication value. - * - REJECTED - Consumer rejected the transaction. - * - RESEND - Consumer requested to resend the authentication value. - * @example ENTERED - * @enum {string} - */ - AuthorizationResponseType: "ENTERED" | "REJECTED" | "RESEND"; - /** - * AuthorizationIDPutResponse - * @description The object sent in the PUT /authorizations/{ID} callback. - */ - AuthorizationIDPutResponse: { - authenticationInfo?: components["schemas"]["AuthenticationInfo"]; - responseType: components["schemas"]["AuthorizationResponseType"]; - }; - requestToPayTransferResponse: { - transferId?: components["schemas"]["CorrelationId"]; - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeR2PTransactionId?: string; - transactionRequestId: components["schemas"]["CorrelationId"]; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - note?: components["schemas"]["Note"]; - currentState?: components["schemas"]["transferStatus"]; - quoteId?: components["schemas"]["CorrelationId"]; - quoteResponse?: { - body: components["schemas"]["QuotesIDPutResponse"]; - headers?: Record; - }; - /** @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. */ - quoteResponseSource?: string; - authorizationResponse?: { - body: components["schemas"]["AuthorizationIDPutResponse"]; - headers?: Record; - }; - fulfil?: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers?: Record; - }; - lastError?: components["schemas"]["transferError"]; - }; - transferContinuationAcceptOTP: { - /** @enum {boolean} */ - acceptOTP: true | false; - }; - /** - * TransfersPostRequest - * @description The object sent in the POST /transfers request. - */ - TransfersPostRequest: { - transferId: components["schemas"]["CorrelationId"]; - payeeFsp: components["schemas"]["FspId"]; - payerFsp: components["schemas"]["FspId"]; - amount: components["schemas"]["Money"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** SimpleTransfersPostRequest */ - simpleTransfersPostRequest: { - fspId: components["schemas"]["FspId"]; - transfersPostRequest: components["schemas"]["TransfersPostRequest"]; - }; - /** SimpleTransfersPostResponse */ - simpleTransfersPostResponse: { - transfer: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers: Record; - }; - currentState: components["schemas"]["async2SyncCurrentState"]; - }; - errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & Record; - transferRequest: { - /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ - homeTransactionId: string; - from: components["schemas"]["transferParty"]; - to: components["schemas"]["transferParty"]; - amountType: components["schemas"]["AmountType"]; - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - transactionType: components["schemas"]["transferTransactionType"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - note?: components["schemas"]["Note"]; - quoteRequestExtensions?: components["schemas"]["extensionListEmptiable"]; - transferRequestExtensions?: components["schemas"]["extensionListEmptiable"]; - /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ - skipPartyLookup?: boolean; - }; - transferStatusResponse: { - transferId: components["schemas"]["CorrelationId"]; - currentState: components["schemas"]["transferStatus"]; - fulfil: { - body: components["schemas"]["TransfersIDPutResponse"]; - headers?: Record; - }; - }; - transferContinuationAcceptConversion: { - /** @enum {boolean} */ - acceptConversion: true | false; - }; - /** - * ServicesFXPPutResponse - * @description The object sent in the PUT /services/FXP callback. - */ - ServicesFXPPutResponse: { - /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */ - providers: components["schemas"]["FspId"][]; - }; - /** - * FxQuotesPostOutboundRequest - * @description The object sent in the POST /fxQuotes request. - */ - FxQuotesPostOutboundRequest: { - /** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */ - homeTransactionId?: string; - conversionRequestId: components["schemas"]["CorrelationId"]; - conversionTerms: components["schemas"]["FxConversion"]; - }; - commitRequestId: components["schemas"]["CorrelationId"]; - determiningTransferId: components["schemas"]["CorrelationId"]; - initiatingFsp: components["schemas"]["FspId"]; - counterPartyFsp: components["schemas"]["FspId"]; - sourceAmount: components["schemas"]["Money"]; - targetAmount: components["schemas"]["Money"]; - condition: components["schemas"]["IlpCondition"]; - /** - * FxTransfersPostOutboundRequest - * @description The object sent in the POST /fxTransfers request. - */ - FxTransfersPostOutboundRequest: { - /** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */ - homeTransactionId?: string; - commitRequestId: components["schemas"]["commitRequestId"]; - determiningTransferId?: components["schemas"]["determiningTransferId"]; - initiatingFsp: components["schemas"]["initiatingFsp"]; - counterPartyFsp: components["schemas"]["counterPartyFsp"]; - sourceAmount: components["schemas"]["sourceAmount"]; - targetAmount: components["schemas"]["targetAmount"]; - condition?: components["schemas"]["condition"]; - }; - fulfilment: components["schemas"]["IlpFulfilment"]; - completedTimestamp: components["schemas"]["DateTime"]; - conversionState: components["schemas"]["TransferState"]; - /** - * FxTransfersPostOutboundResponse - * @description The object sent as a response for the POST /fxTransfers request. - */ - FxTransfersPostOutboundResponse: { - /** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */ - homeTransactionId?: string; - fulfilment?: components["schemas"]["fulfilment"]; - completedTimestamp?: components["schemas"]["completedTimestamp"]; - conversionState: components["schemas"]["conversionState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - }; - responses: { - /** @description Malformed or missing required headers or parameters. */ - 400: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - /** @description An error occurred processing the request. */ - 500: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - /** @description Accounts creation completed */ - accountsCreationCompleted: { - content: { - "application/json": components["schemas"]["accountsResponse"]; - }; - }; - /** @description An error occurred creating accounts */ - accountsCreationError: { - content: { - "application/json": components["schemas"]["errorAccountsResponse"]; - }; - }; - /** @description Timeout occurred creating accounts */ - accountsCreationTimeout: { - content: { - "application/json": components["schemas"]["errorAccountsResponse"]; - }; - }; - /** @description Bulk quote completed successfully */ - bulkQuoteSuccess: { - content: { - "application/json": components["schemas"]["bulkQuoteResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - bulkQuoteBadRequest: { - content: { - "application/json": components["schemas"]["bulkQuoteErrorResponse"]; - }; - }; - /** @description An error occurred processing the bulk quote */ - bulkQuoteServerError: { - content: { - "application/json": components["schemas"]["bulkQuoteErrorResponse"]; - }; - }; - /** @description Timeout occurred processing the bulk quote */ - bulkQuoteTimeout: { - content: { - "application/json": components["schemas"]["bulkQuoteErrorResponse"]; - }; - }; - /** @description Bulk transfer accepted successfully */ - bulkTransactionAccepted: { - content: never; - }; - /** @description Malformed or missing required body, headers or parameters */ - bulkTransferBadRequest: { - content: { - "application/json": components["schemas"]["bulkTransferErrorResponse"]; - }; - }; - /** @description Internal Server Error */ - errorResponse: { - content: { - "application/json": components["schemas"]["errorResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - bulkTransactionPutBadRequest: { - content: { - "application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"]; - }; - }; - /** @description Bulk transfer completed successfully */ - bulkTransferSuccess: { - content: { - "application/json": components["schemas"]["bulkTransferResponse"]; - }; - }; - /** @description PartiesByIdSuccess */ - partiesByIdSuccess: { - content: { - "application/json": components["schemas"]["partiesByIdResponse"]; - }; - }; - /** @description PartiesByIdError404 */ - partiesByIdError404: { - content: { - "application/json": { - errorInformation?: components["schemas"]["ErrorInformation"]; + schemas: { + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + accountsRequest: { + idType: components["schemas"]["PartyIdType"]; + idValue: components["schemas"]["PartyIdentifier"]; + idSubValue?: components["schemas"]["PartySubIdOrType"]; + currency: components["schemas"]["Currency"]; + }[]; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + errorResponse: { + /** @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. + * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message. + * */ + statusCode?: string; + /** @description Error message text. */ + message?: string; + }; + accountCreationStatus: { + idType: components["schemas"]["PartyIdType"]; + idValue: components["schemas"]["PartyIdentifier"]; + idSubValue?: components["schemas"]["PartySubIdOrType"]; + error?: components["schemas"]["errorResponse"]; + }[]; + /** @enum {string} */ + accountsCreationState: "ERROR_OCCURRED" | "COMPLETED"; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + mojaloopError: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** @description This object represents a Mojaloop API error received at any time during the transfer process */ + transferError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + accountsResponse: { + modelId?: components["schemas"]["CorrelationId"]; + accounts: components["schemas"]["accountsRequest"]; + response?: components["schemas"]["accountCreationStatus"]; + currentState?: components["schemas"]["accountsCreationState"]; + lastError?: components["schemas"]["transferError"]; + postAccountsResponse?: { + body: Record; + headers?: Record; + }; + }; + errorAccountsResponse: components["schemas"]["errorResponse"] & { + executionState: components["schemas"]["accountsResponse"]; + }; + /** + * TransactionInitiatorType + * @description Below are the allowed values for the enumeration. + * - CONSUMER - Consumer is the initiator of the transaction. + * - AGENT - Agent is the initiator of the transaction. + * - BUSINESS - Business is the initiator of the transaction. + * - DEVICE - Device is the initiator of the transaction. + * @example CONSUMER + * @enum {string} + */ + TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** + * Name + * @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. + * + * 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 ( ). + * + * **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. + */ + Name: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** + * KYCInformation + * @description KYC information for the party in a form mandated by an individual scheme. + * @example { + * "metadata": { + * "format": "JSON", + * "version": "1.0", + * "description": "Data containing KYC Information" + * }, + * "data": { + * "name": "John Doe", + * "dob": "1980-05-15", + * "gender": "Male", + * "address": "123 Main Street, Anytown, USA", + * "email": "johndoe@example.com", + * "phone": "+1 555-123-4567", + * "nationality": "US", + * "passport_number": "AB1234567", + * "issue_date": "2010-02-20", + * "expiry_date": "2025-02-20", + * "bank_account_number": "1234567890", + * "bank_name": "Example Bank", + * "employer": "ABC Company", + * "occupation": "Software Engineer", + * "income": "$80,000 per year", + * "marital_status": "Single", + * "dependents": 0, + * "risk_level": "Low" + * } + * } + */ + KYCInformation: string; + extensionListEmptiable: components["schemas"]["Extension"][]; + transferParty: { + type?: components["schemas"]["TransactionInitiatorType"]; + idType: components["schemas"]["PartyIdType"]; + idValue: components["schemas"]["PartyIdentifier"]; + idSubValue?: components["schemas"]["PartySubIdOrType"]; + displayName?: components["schemas"]["Name"]; + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + fspId?: components["schemas"]["FspId"]; + /** @description Currencies in which the party can receive funds. */ + supportedCurrencies?: components["schemas"]["Currency"][]; + kycInformation?: components["schemas"]["KYCInformation"]; + extensionList?: components["schemas"]["extensionListEmptiable"]; + }; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + /** + * transferTransactionType + * @description Type of transaction. + * @enum {string} + */ + transferTransactionType: "TRANSFER"; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * IndividualQuote + * @description Data model for the complex type 'individualQuote'. + */ + individualQuote: { + quoteId: components["schemas"]["CorrelationId"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + note?: components["schemas"]["Note"]; + extensions?: components["schemas"]["ExtensionList"]; + }; + bulkQuoteRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + bulkQuoteId?: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + /** @description List of individual quotes in a bulk quote. */ + individualQuotes: components["schemas"]["individualQuote"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + /** @enum {string} */ + bulkTransferStatus: "ERROR_OCCURRED" | "COMPLETED"; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** @description This object represents a Mojaloop API error received at any time during the quote process */ + quoteError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + individualQuoteResult: { + quoteId: components["schemas"]["CorrelationId"]; + transferAmount?: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket?: components["schemas"]["IlpPacket"]; + condition?: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["quoteError"]; + }; + bulkQuoteResponse: { + bulkQuoteId: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId?: string; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + currentState: components["schemas"]["bulkTransferStatus"]; + /** @description List of individualQuoteResults in a bulk transfer response. */ + individualQuoteResults: components["schemas"]["individualQuoteResult"][]; + }; + bulkQuoteErrorResponse: components["schemas"]["errorResponse"] & { + bulkQuoteState: components["schemas"]["bulkQuoteResponse"]; + }; + /** @enum {string} */ + bulkQuoteStatus: "ERROR_OCCURRED" | "COMPLETED"; + bulkQuoteStatusResponse: { + bulkQuoteId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["bulkQuoteStatus"]; + individualQuotes: components["schemas"]["individualQuote"][]; + }; + autoAcceptPartyOption: { + /** @enum {boolean} */ + enabled: false | true; + }; + bulkPerTransferFeeLimit: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + autoAcceptQuote: { + /** @enum {boolean} */ + enabled: true | false; + perTransferFeeLimits?: components["schemas"]["bulkPerTransferFeeLimit"][]; + }; + bulkTransactionOptions: { + /** @description Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution. */ + onlyValidateParty?: boolean; + autoAcceptParty: components["schemas"]["autoAcceptPartyOption"]; + /** @description Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array. */ + autoAcceptQuote: components["schemas"]["autoAcceptQuote"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + /** @description Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done */ + synchronous?: boolean; + bulkExpiration: components["schemas"]["DateTime"]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1 + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + kycInformation?: components["schemas"]["KYCInformation"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + /** @description Currencies in which the party can receive funds. */ + supportedCurrencies?: components["schemas"]["Currency"][]; + }; + /** + * BulkTransactionIndividualTransfer + * @description Data model for the complex type 'bulkTransactionIndividualTransfer'. + */ + bulkTransactionIndividualTransfer: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + to: components["schemas"]["Party"]; + /** @description Payer Loan reference */ + reference?: string; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + note?: components["schemas"]["Note"]; + quoteExtensions?: components["schemas"]["ExtensionList"]; + transferExtensions?: components["schemas"]["ExtensionList"]; + lastError?: components["schemas"]["transferError"]; + }; + bulkTransactionRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + bulkHomeTransactionID: string; + bulkTransactionId: components["schemas"]["CorrelationId"]; + options: components["schemas"]["bulkTransactionOptions"]; + from: components["schemas"]["Party"]; + /** @description List of individual transfers in a bulk transfer. */ + individualTransfers: components["schemas"]["bulkTransactionIndividualTransfer"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** + * TransferState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Next ledger has received the transfer. + * - RESERVED - Next ledger has reserved the transfer. + * - COMMITTED - Next ledger has successfully performed the transfer. + * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer. + * @example RESERVED + * @enum {string} + */ + TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED"; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + individualTransferResult: { + transferId: components["schemas"]["CorrelationId"]; + fulfilment?: components["schemas"]["IlpFulfilment"]; + extensionList?: components["schemas"]["ExtensionList"]; + transferState?: components["schemas"]["TransferState"]; + lastError?: components["schemas"]["transferError"]; + }; + bulkTransferResponse: { + bulkTransferId: components["schemas"]["CorrelationId"]; + bulkQuoteId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId?: string; + bulkTransferState?: components["schemas"]["TransferState"]; + completedTimestamp?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + currentState: components["schemas"]["bulkTransferStatus"]; + /** @description List of individual transfer result in a bulk transfer response. */ + individualTransferResults: components["schemas"]["individualTransferResult"][]; + }; + bulkTransferErrorResponse: components["schemas"]["errorResponse"] & { + bulkTransferState: components["schemas"]["bulkTransferResponse"]; + }; + /** @description Data model for the 'individualTransfer' while accepting party or quote. */ + bulkTransactionIndividualTransferAccept: { + transferId: components["schemas"]["CorrelationId"]; + }; + transferContinuationAcceptParty: { + /** @enum {boolean} */ + acceptParty: true | false; + }; + /** @description The object sent back as confirmation of payee parties when autoAcceptParty is false. */ + bulkTransactionContinuationAcceptParty: { + /** @description List of individual transfers in a bulk transfer with accept party information. */ + individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptParty"])[]; + }; + transferContinuationAcceptQuote: { + /** @enum {boolean} */ + acceptQuote: true | false; + }; + /** @description The object sent back as confirmation of quotes when autoAcceptQuotes is false. */ + bulkTransactionContinuationAcceptQuote: { + /** @description List of individual transfers in a bulk transfer. */ + individualTransfers: (components["schemas"]["bulkTransactionIndividualTransferAccept"] & components["schemas"]["transferContinuationAcceptQuote"])[]; + }; + /** @description This object represents a Mojaloop API error received at any time during the party discovery process */ + partyError: { + /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */ + httpStatusCode?: number; + mojaloopError?: components["schemas"]["mojaloopError"]; + }; + bulkTransactionAcceptPartyErrorResponse: components["schemas"]["errorResponse"] & { + bulkTransferState: components["schemas"]["bulkTransactionContinuationAcceptParty"] & components["schemas"]["partyError"]; + }; + bulkTransactionAcceptQuoteErrorResponse: components["schemas"]["errorResponse"] & { + bulkTransferState?: components["schemas"]["bulkTransactionContinuationAcceptQuote"] & components["schemas"]["quoteError"]; + }; + /** + * IndividualTransfer + * @description Data model for the complex type 'individualTransfer'. + */ + individualTransfer: { + transferId: components["schemas"]["CorrelationId"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType?: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + note?: components["schemas"]["Note"]; + extensions?: components["schemas"]["ExtensionList"]; + }; + bulkTransferRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + bulkTransferId: components["schemas"]["CorrelationId"]; + bulkQuoteId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + /** @description List of individual transfers in a bulk transfer. */ + individualTransfers: components["schemas"]["individualTransfer"][]; + extensions?: components["schemas"]["ExtensionList"]; + }; + /** @description A Mojaloop API transfer fulfilment for individual transfers in a bulk transfer */ + individualTransferFulfilment: { + fulfilment?: components["schemas"]["IlpFulfilment"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + bulkTransferStatusResponse: { + bulkTransferId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["bulkTransferStatus"]; + fulfils: components["schemas"]["individualTransferFulfilment"][]; + }; + /** @enum {string} */ + async2SyncCurrentState: "WAITING_FOR_ACTION" | "COMPLETED" | "ERROR_OCCURRED"; + /** + * partiesByIdResponse + * @description GET /parties/{Type}/{ID} response object + */ + partiesByIdResponse: { + party: { + body: components["schemas"]["Party"]; + headers: Record; + }; + currentState: components["schemas"]["async2SyncCurrentState"]; + }; + /** + * TransactionScenario + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. + * - 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. + * - REFUND - Used for performing a refund of transaction. + * @example DEPOSIT + * @enum {string} + */ + TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; + /** + * TransactionInitiator + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * @example PAYEE + * @enum {string} + */ + TransactionInitiator: "PAYER" | "PAYEE"; + /** + * RefundReason + * @description Reason for the refund. + * @example Free text indicating reason for the refund. + */ + RefundReason: string; + /** + * Refund + * @description Data model for the complex type Refund. + */ + Refund: { + originalTransactionId: components["schemas"]["CorrelationId"]; + refundReason?: components["schemas"]["RefundReason"]; + }; + /** + * BalanceOfPayments + * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. + * @example 123 + */ + BalanceOfPayments: string; + /** + * TransactionType + * @description Data model for the complex type TransactionType. + */ + TransactionType: { + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + refundInfo?: components["schemas"]["Refund"]; + balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; + }; + /** + * CurrencyConverter + * @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee. + * @enum {string} + */ + CurrencyConverter: "PAYER" | "PAYEE"; + /** + * FxRate + * @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. + */ + FxRate: { + sourceAmount: components["schemas"]["Money"] & unknown; + targetAmount: components["schemas"]["Money"] & unknown; + }; + /** + * QuotesPostRequest + * @description The object sent in the POST /quotes request. + */ + QuotesPostRequest: { + quoteId: components["schemas"]["CorrelationId"]; + transactionId: components["schemas"]["CorrelationId"]; + transactionRequestId?: components["schemas"]["CorrelationId"]; + payee: components["schemas"]["Party"]; + payer: components["schemas"]["Party"]; + amountType: components["schemas"]["AmountType"]; + amount: components["schemas"]["Money"]; + fees?: components["schemas"]["Money"]; + transactionType: components["schemas"]["TransactionType"]; + converter?: components["schemas"]["CurrencyConverter"] & unknown; + currencyConversion?: components["schemas"]["FxRate"] & unknown; + geoCode?: components["schemas"]["GeoCode"]; + note?: components["schemas"]["Note"]; + expiration?: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** simpleQuotesPostRequest */ + simpleQuotesPostRequest: { + fspId: components["schemas"]["FspId"]; + quotesPostRequest: components["schemas"]["QuotesPostRequest"]; + }; + /** QuotesPostResponse */ + quotesPostResponse: { + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + quotes: { + body: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + /** + * @description Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + headers: Record; + }; + currentState: components["schemas"]["async2SyncCurrentState"]; + }; + errorQuotesResponse: components["schemas"]["errorResponse"] & Record; + /** + * AuthenticationType + * @description Below are the allowed values for the enumeration AuthenticationType. + * - OTP - One-time password generated by the Payer FSP. + * - QRCODE - QR code used as One Time Password. + * - U2F - U2F is a new addition isolated to Thirdparty stream. + * @example OTP + * @enum {string} + */ + AuthenticationType: "OTP" | "QRCODE" | "U2F"; + requestToPayRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId: string; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + }; + /** @enum {string} */ + requestToPayStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "COMPLETED"; + /** + * getPartiesResponse + * @description The object sent in the GET /parties/{Type}/{ID} callback. + */ + getPartiesResponse: { + body: components["schemas"]["Party"]; + headers: Record; + }; + /** + * TransactionRequestState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. + * - PENDING - Payer FSP has sent the transaction request to the Payer. + * - ACCEPTED - Payer has approved the transaction. + * - REJECTED - Payer has rejected the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * TransactionRequestResponse + * @description The object sent in the PUT /transactionRequests/{ID} callback. + */ + TransactionRequestResponse: { + body: { + transactionId?: components["schemas"]["CorrelationId"]; + transactionRequestState: components["schemas"]["TransactionRequestState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + headers: Record; + }; + requestToPayResponse: { + transactionRequestId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + currentState: components["schemas"]["requestToPayStatus"]; + getPartiesResponse?: components["schemas"]["getPartiesResponse"]; + transactionRequestResponse?: components["schemas"]["TransactionRequestResponse"]; + lastError?: components["schemas"]["transferError"]; + }; + /** @enum {string} */ + transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "WAITING_FOR_CONVERSION_ACCEPTANCE" | "COMPLETED"; + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + QuotesIDPutResponse: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + expiration: components["schemas"]["DateTime"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * FxMoney + * @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations. + */ + FxMoney: { + currency: components["schemas"]["Currency"]; + amount?: components["schemas"]["Amount"]; + }; + /** + * FxCharge + * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object. + */ + FxCharge: { + /** @description A description of the charge which is being levied. */ + chargeType: string; + sourceAmount?: components["schemas"]["Money"] & unknown; + targetAmount?: components["schemas"]["Money"] & unknown; + }; + /** + * FxConversion + * @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. + */ + FxConversion: { + conversionId: components["schemas"]["CorrelationId"] & unknown; + determiningTransferId?: components["schemas"]["CorrelationId"] & unknown; + initiatingFsp: components["schemas"]["FspId"] & unknown; + counterPartyFsp: components["schemas"]["FspId"] & unknown; + amountType: components["schemas"]["AmountType"] & unknown; + sourceAmount: components["schemas"]["FxMoney"] & unknown; + targetAmount: components["schemas"]["FxMoney"] & unknown; + expiration: components["schemas"]["DateTime"] & unknown; + /** @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. */ + charges?: components["schemas"]["FxCharge"][]; + extensionList?: components["schemas"]["ExtensionList"] & unknown; + }; + /** + * FxQuotesPostOutboundResponse + * @description The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester. + */ + FxQuotesPostOutboundResponse: { + /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */ + homeTransactionId?: string; + condition?: components["schemas"]["IlpCondition"] & unknown; + conversionTerms: components["schemas"]["FxConversion"] & unknown; + }; + /** + * TransfersIDPutResponse + * @description The object sent in the PUT /transfers/{ID} callback. + */ + TransfersIDPutResponse: { + fulfilment?: components["schemas"]["IlpFulfilment"]; + completedTimestamp?: components["schemas"]["DateTime"]; + transferState: components["schemas"]["TransferState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + transferResponse: { + transferId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + note?: components["schemas"]["Note"]; + currentState?: components["schemas"]["transferStatus"]; + quoteId?: components["schemas"]["CorrelationId"]; + getPartiesResponse?: { + body: Record; + headers?: Record; + }; + quoteResponse?: { + body: components["schemas"]["QuotesIDPutResponse"]; + headers?: Record; + }; + /** @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. + * */ + quoteResponseSource?: string; + conversionRequestId?: components["schemas"]["CorrelationId"]; + fxQuotesResponse?: { + body: components["schemas"]["FxQuotesPostOutboundResponse"]; + headers?: Record; + }; + /** @description FXPID of the entity that supplied the fxQuotes response. + * */ + fxQuotesResponseSource?: string; + fulfil?: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers?: Record; + }; + lastError?: components["schemas"]["transferError"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + }; + errorTransferResponse: components["schemas"]["errorResponse"] & { + transferState: components["schemas"]["transferResponse"]; + }; + requestToPayTransferRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId: string; + transactionRequestId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + note?: components["schemas"]["Note"]; + authenticationType?: components["schemas"]["AuthenticationType"]; + }; + /** + * AuthenticationValue + * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type. + */ + AuthenticationValue: string | { + /** @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key. + * */ + pinValue: string; + /** + * Integer + * @description Sequential counter used for cloning detection. Present only for U2F authentication. + */ + counter: string; + }; + /** + * AuthenticationInfo + * @description Data model for the complex type AuthenticationInfo. + */ + AuthenticationInfo: { + authentication: components["schemas"]["AuthenticationType"]; + authenticationValue: components["schemas"]["AuthenticationValue"]; + }; + /** + * AuthorizationResponseType + * @description Below are the allowed values for the enumeration. + * - ENTERED - Consumer entered the authentication value. + * - REJECTED - Consumer rejected the transaction. + * - RESEND - Consumer requested to resend the authentication value. + * @example ENTERED + * @enum {string} + */ + AuthorizationResponseType: "ENTERED" | "REJECTED" | "RESEND"; + /** + * AuthorizationIDPutResponse + * @description The object sent in the PUT /authorizations/{ID} callback. + */ + AuthorizationIDPutResponse: { + authenticationInfo?: components["schemas"]["AuthenticationInfo"]; + responseType: components["schemas"]["AuthorizationResponseType"]; + }; + requestToPayTransferResponse: { + transferId?: components["schemas"]["CorrelationId"]; + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeR2PTransactionId?: string; + transactionRequestId: components["schemas"]["CorrelationId"]; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + note?: components["schemas"]["Note"]; + currentState?: components["schemas"]["transferStatus"]; + quoteId?: components["schemas"]["CorrelationId"]; + quoteResponse?: { + body: components["schemas"]["QuotesIDPutResponse"]; + headers?: Record; + }; + /** @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. + * */ + quoteResponseSource?: string; + authorizationResponse?: { + body: components["schemas"]["AuthorizationIDPutResponse"]; + headers?: Record; + }; + fulfil?: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers?: Record; + }; + lastError?: components["schemas"]["transferError"]; + }; + transferContinuationAcceptOTP: { + /** @enum {boolean} */ + acceptOTP: true | false; + }; + /** + * TransfersPostRequest + * @description The object sent in the POST /transfers request. + */ + TransfersPostRequest: { + transferId: components["schemas"]["CorrelationId"]; + payeeFsp: components["schemas"]["FspId"]; + payerFsp: components["schemas"]["FspId"]; + amount: components["schemas"]["Money"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** SimpleTransfersPostRequest */ + simpleTransfersPostRequest: { + fspId: components["schemas"]["FspId"]; + transfersPostRequest: components["schemas"]["TransfersPostRequest"]; + }; + /** SimpleTransfersPostResponse */ + simpleTransfersPostResponse: { + transfer: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers: Record; + }; + currentState: components["schemas"]["async2SyncCurrentState"]; + }; + errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & Record; + transferRequest: { + /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */ + homeTransactionId: string; + from: components["schemas"]["transferParty"]; + to: components["schemas"]["transferParty"]; + amountType: components["schemas"]["AmountType"]; + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + transactionType: components["schemas"]["transferTransactionType"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + note?: components["schemas"]["Note"]; + quoteRequestExtensions?: components["schemas"]["extensionListEmptiable"]; + transferRequestExtensions?: components["schemas"]["extensionListEmptiable"]; + /** @description Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful is a previous party resolution has been performed. */ + skipPartyLookup?: boolean; + }; + transferStatusResponse: { + transferId: components["schemas"]["CorrelationId"]; + currentState: components["schemas"]["transferStatus"]; + fulfil: { + body: components["schemas"]["TransfersIDPutResponse"]; + headers?: Record; + }; + }; + transferContinuationAcceptConversion: { + /** @enum {boolean} */ + acceptConversion: true | false; + }; + /** + * ServicesFXPPutResponse + * @description The object sent in the PUT /services/FXP callback. + */ + ServicesFXPPutResponse: { + /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */ + providers: components["schemas"]["FspId"][]; + }; + /** + * FxQuotesPostOutboundRequest + * @description The object sent in the POST /fxQuotes request. + */ + FxQuotesPostOutboundRequest: { + /** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */ + homeTransactionId?: string; + conversionRequestId: components["schemas"]["CorrelationId"] & unknown; + conversionTerms: components["schemas"]["FxConversion"] & unknown; + }; + commitRequestId: components["schemas"]["CorrelationId"] & unknown; + determiningTransferId: components["schemas"]["CorrelationId"] & unknown; + initiatingFsp: components["schemas"]["FspId"] & unknown; + counterPartyFsp: components["schemas"]["FspId"] & unknown; + sourceAmount: components["schemas"]["Money"] & unknown; + targetAmount: components["schemas"]["Money"] & unknown; + condition: components["schemas"]["IlpCondition"] & unknown; + /** + * FxTransfersPostOutboundRequest + * @description The object sent in the POST /fxTransfers request. + */ + FxTransfersPostOutboundRequest: { + /** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */ + homeTransactionId?: string; + commitRequestId: components["schemas"]["commitRequestId"]; + determiningTransferId?: components["schemas"]["determiningTransferId"]; + initiatingFsp: components["schemas"]["initiatingFsp"]; + counterPartyFsp: components["schemas"]["counterPartyFsp"]; + sourceAmount: components["schemas"]["sourceAmount"]; + targetAmount: components["schemas"]["targetAmount"]; + condition?: components["schemas"]["condition"]; + }; + fulfilment: components["schemas"]["IlpFulfilment"] & unknown; + completedTimestamp: components["schemas"]["DateTime"] & unknown; + conversionState: components["schemas"]["TransferState"] & unknown; + /** + * FxTransfersPostOutboundResponse + * @description The object sent as a response for the POST /fxTransfers request. + */ + FxTransfersPostOutboundResponse: { + /** @description Transaction ID for the backend, used to reconcile transactions between the Switch and backend systems. */ + homeTransactionId?: string; + fulfilment?: components["schemas"]["fulfilment"]; + completedTimestamp?: components["schemas"]["completedTimestamp"]; + conversionState: components["schemas"]["conversionState"]; + extensionList?: components["schemas"]["ExtensionList"]; }; - }; - }; - /** @description sync response from POST /quotes */ - quotesPostSuccess: { - content: { - "application/json": components["schemas"]["quotesPostResponse"]; - }; - }; - /** @description An error occurred processing the quotes request */ - quotesServerError: { - content: { - "application/json": components["schemas"]["errorQuotesResponse"]; - }; - }; - /** @description Request to Pay completed successfully */ - requestToPaySuccess: { - content: { - "application/json": components["schemas"]["requestToPayResponse"]; - }; - }; - /** @description An error occurred processing the transfer */ - transferServerError: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; - }; - /** @description Timeout occurred processing the transfer */ - transferTimeout: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; - }; - /** @description Transfer completed successfully */ - requestToPayTransferSuccess: { - content: { - "application/json": components["schemas"]["requestToPayTransferResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - requestToPayTransferBadRequest: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; - }; - /** @description Transfer completed successfully */ - transferSuccess: { - content: { - "application/json": components["schemas"]["transferResponse"]; - }; - }; - /** @description sync response from POST /simpleTransfers */ - simpleTransfersPostSuccess: { - content: { - "application/json": components["schemas"]["simpleTransfersPostResponse"]; - }; - }; - /** @description An error occurred processing the simple transfers request */ - simpleTransfersServerError: { - content: { - "application/json": components["schemas"]["errorSimpleTransfersResponse"]; - }; - }; - /** @description Malformed or missing required body, headers or parameters */ - transferBadRequest: { - content: { - "application/json": components["schemas"]["errorTransferResponse"]; - }; }; - /** @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. */ - servicesFXPSucess: { - content: { - "application/json": components["schemas"]["ServicesFXPPutResponse"]; - }; + responses: { + /** @description Malformed or missing required headers or parameters. */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description An error occurred processing the request. */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description Accounts creation completed */ + accountsCreationCompleted: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["accountsResponse"]; + }; + }; + /** @description An error occurred creating accounts */ + accountsCreationError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorAccountsResponse"]; + }; + }; + /** @description Timeout occurred creating accounts */ + accountsCreationTimeout: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorAccountsResponse"]; + }; + }; + /** @description Bulk quote completed successfully */ + bulkQuoteSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + bulkQuoteBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteErrorResponse"]; + }; + }; + /** @description An error occurred processing the bulk quote */ + bulkQuoteServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteErrorResponse"]; + }; + }; + /** @description Timeout occurred processing the bulk quote */ + bulkQuoteTimeout: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkQuoteErrorResponse"]; + }; + }; + /** @description Bulk transfer accepted successfully */ + bulkTransactionAccepted: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Malformed or missing required body, headers or parameters */ + bulkTransferBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferErrorResponse"]; + }; + }; + /** @description Internal Server Error */ + errorResponse: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + bulkTransactionPutBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransactionAcceptPartyErrorResponse"] | components["schemas"]["bulkTransactionAcceptQuoteErrorResponse"]; + }; + }; + /** @description Bulk transfer completed successfully */ + bulkTransferSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["bulkTransferResponse"]; + }; + }; + /** @description PartiesByIdSuccess */ + partiesByIdSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["partiesByIdResponse"]; + }; + }; + /** @description PartiesByIdError404 */ + partiesByIdError404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + }; + }; + /** @description sync response from POST /quotes */ + quotesPostSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["quotesPostResponse"]; + }; + }; + /** @description An error occurred processing the quotes request */ + quotesServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorQuotesResponse"]; + }; + }; + /** @description Request to Pay completed successfully */ + requestToPaySuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["requestToPayResponse"]; + }; + }; + /** @description An error occurred processing the transfer */ + transferServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @description Timeout occurred processing the transfer */ + transferTimeout: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @description Transfer completed successfully */ + requestToPayTransferSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["requestToPayTransferResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + requestToPayTransferBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @description Transfer completed successfully */ + transferSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["transferResponse"]; + }; + }; + /** @description sync response from POST /simpleTransfers */ + simpleTransfersPostSuccess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simpleTransfersPostResponse"]; + }; + }; + /** @description An error occurred processing the simple transfers request */ + simpleTransfersServerError: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorSimpleTransfersResponse"]; + }; + }; + /** @description Malformed or missing required body, headers or parameters */ + transferBadRequest: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["errorTransferResponse"]; + }; + }; + /** @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. */ + servicesFXPSucess: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ServicesFXPPutResponse"]; + }; + }; }; - }; - parameters: { - /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ - bulkQuoteId: components["schemas"]["CorrelationId"]; - /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ - bulkTransactionId: components["schemas"]["CorrelationId"]; - /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ - bulkTransferId: components["schemas"]["CorrelationId"]; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - Type: string; - /** @description The identifier value. */ - ID: string; - /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ - SubId: string; - /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ - transactionRequestId: components["schemas"]["CorrelationId"]; - /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ - transferId: components["schemas"]["CorrelationId"]; - /** @description ISO 4217 currency code for the source currency. */ - SourceCurrency: string; - /** @description ISO 4217 currency code for the target currency. */ - TargetCurrency: string; - }; - requestBodies: never; - headers: never; - pathItems: never; + parameters: { + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkQuoteId: components["schemas"]["CorrelationId"]; + /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */ + bulkTransactionId: components["schemas"]["CorrelationId"]; + /** @description Identifier of the bulk transfer to continue as returned in the response to a `POST /bulkTransfers` request. */ + bulkTransferId: components["schemas"]["CorrelationId"]; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The identifier value. */ + ID: string; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: string; + /** @description Identifier of the merchant request to pay to continue as returned in the response to a `POST /requestToPay` request. */ + transactionRequestId: components["schemas"]["CorrelationId"]; + /** @description Identifier of the transfer to continue as returned in the response to a `POST /transfers` request. */ + transferId: components["schemas"]["CorrelationId"]; + /** @description ISO 4217 currency code for the source currency. */ + SourceCurrency: string; + /** @description ISO 4217 currency code for the target currency. */ + TargetCurrency: string; + }; + requestBodies: never; + headers: never; + pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - - /** - * PartiesByTypeAndID - * @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). - */ - PartiesByTypeAndID: { - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 200: components["responses"]["partiesByIdSuccess"]; - 404: components["responses"]["partiesByIdError404"]; - }; - }; - /** - * PartiesSubIdByTypeAndID - * @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). - */ - PartiesSubIdByTypeAndID: { - parameters: { - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - SubId: components["parameters"]["SubId"]; - }; - }; - responses: { - 200: components["responses"]["partiesByIdSuccess"]; - 404: components["responses"]["partiesByIdError404"]; - }; - }; - /** - * Quotes endpoint - * @description is used to request quotes from other DFSP - */ - QuotesPost: { - /** @description Quotes request payload */ - requestBody: { - content: { - "application/json": components["schemas"]["simpleQuotesPostRequest"]; - }; - }; - responses: { - 200: components["responses"]["quotesPostSuccess"]; - 500: components["responses"]["quotesServerError"]; - }; - }; - /** - * Simple Transfers endpoint - * @description is used to request a transfer - */ - SimpleTransfersPost: { - /** @description Simple Transfer request payload */ - requestBody: { - content: { - "application/json": components["schemas"]["simpleTransfersPostRequest"]; - }; - }; - responses: { - 200: components["responses"]["simpleTransfersPostSuccess"]; - 500: components["responses"]["simpleTransfersServerError"]; + PartiesByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["partiesByIdSuccess"]; + 404: components["responses"]["partiesByIdError404"]; + }; }; - }; - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services. - */ - ServicesFXPGet: { - responses: { - 200: components["responses"]["servicesFXPSucess"]; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + PartiesSubIdByTypeAndID: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */ + SubId: components["parameters"]["SubId"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["partiesByIdSuccess"]; + 404: components["responses"]["partiesByIdError404"]; + }; }; - }; - /** - * Obtain a list of the DFSPs in the scheme who provide FXP service - * @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. - */ - ServicesFXPSourceCurrencyTargetCurrencyGet: { - parameters: { - path: { - SourceCurrency: components["parameters"]["SourceCurrency"]; - TargetCurrency: components["parameters"]["TargetCurrency"]; - }; + QuotesPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Quotes request payload */ + requestBody: { + content: { + "application/json": components["schemas"]["simpleQuotesPostRequest"]; + }; + }; + responses: { + 200: components["responses"]["quotesPostSuccess"]; + 500: components["responses"]["quotesServerError"]; + }; }; - responses: { - 200: components["responses"]["servicesFXPSucess"]; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + SimpleTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Simple Transfer request payload */ + requestBody: { + content: { + "application/json": components["schemas"]["simpleTransfersPostRequest"]; + }; + }; + responses: { + 200: components["responses"]["simpleTransfersPostSuccess"]; + 500: components["responses"]["simpleTransfersServerError"]; + }; }; - }; - /** - * Calculate FX quote - * @description The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion. - */ - FxQuotesPost: { - /** @description Details of the FX quote request. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxQuotesPostOutboundRequest"]; - }; + ServicesFXPGet: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["servicesFXPSucess"]; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Successful response. */ - 200: { - content: { - "application/json": components["schemas"]["FxQuotesPostOutboundResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + ServicesFXPSourceCurrencyTargetCurrencyGet: { + parameters: { + query?: never; + header?: never; + path: { + /** @description ISO 4217 currency code for the source currency. */ + SourceCurrency: components["parameters"]["SourceCurrency"]; + /** @description ISO 4217 currency code for the target currency. */ + TargetCurrency: components["parameters"]["TargetCurrency"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["servicesFXPSucess"]; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; - /** - * Perform FX transfer - * @description The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion. - */ - FxTransfersPost: { - /** @description Details of the FX transfer request. */ - requestBody: { - content: { - "application/json": components["schemas"]["FxTransfersPostOutboundRequest"]; - }; + FxQuotesPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Details of the FX quote request. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxQuotesPostOutboundRequest"]; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["FxQuotesPostOutboundResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - responses: { - /** @description Successful response. */ - 200: { - content: { - "application/json": components["schemas"]["FxTransfersPostOutboundResponse"]; - }; - }; - 400: components["responses"]["400"]; - 500: components["responses"]["500"]; + FxTransfersPost: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description Details of the FX transfer request. */ + requestBody: { + content: { + "application/json": components["schemas"]["FxTransfersPostOutboundRequest"]; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["FxTransfersPostOutboundResponse"]; + }; + }; + 400: components["responses"]["400"]; + 500: components["responses"]["500"]; + }; }; - }; } diff --git a/src/thirdparty/openapi.ts b/src/thirdparty/openapi.ts index df90a426..b319afc5 100644 --- a/src/thirdparty/openapi.ts +++ b/src/thirdparty/openapi.ts @@ -3,3563 +3,4583 @@ * Do not make direct changes to the file. */ - export interface paths { - "/interface": { - /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */ - post: operations["test"]; - }; - "/accounts/{ID}": { - /** - * GetAccountsByUserId - * @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking. - */ - get: operations["GetAccountsByUserId"]; - /** - * UpdateAccountsByUserId - * @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking - */ - put: operations["UpdateAccountsByUserId"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/accounts/{ID}/error": { - /** - * UpdateAccountsByUserIdError - * @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information - */ - put: operations["UpdateAccountsByUserIdError"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/health": { - /** - * Health check endpoint - * @description The HTTP request GET /health is used to return the current status of the API. - */ - get: operations["HealthGet"]; - }; - "/metrics": { - /** - * Prometheus metrics endpoint - * @description The HTTP request GET /metrics is used to return metrics for the API. - */ - get: operations["MetricsGet"]; - }; - "/consentRequests": { - /** - * CreateConsentRequest - * @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more - * accounts owned by a customer of the DFSP for the PISP who sends the request. - */ - post: operations["CreateConsentRequest"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/consentRequests/{ID}": { - /** - * GetConsentRequestsById - * @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously - * requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the - * request by the PISP when the PISP originated the request. - */ - get: operations["GetConsentRequestsById"]; - /** - * UpdateConsentRequest - * @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted, - * and (2) communicate to the PISP which `authChannel` it should use to authenticate their user - * with. - * - * When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all - * the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization - * process may result in additional privileges being granted by the account holder to the PISP. The - * **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a - * particular authorization request. - */ - put: operations["UpdateConsentRequest"]; - /** - * PatchConsentRequest - * @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP. - */ - patch: operations["PatchConsentRequest"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/consentRequests/{ID}/error": { - /** - * NotifyErrorConsentRequests - * @description DFSP responds to the PISP if something went wrong with validating an OTP or secret. - */ - put: operations["NotifyErrorConsentRequests"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/consents": { - /** - * PostConsents - * @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to. - */ - post: operations["PostConsents"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/consents/{ID}": { - /** - * GetConsent - * @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created. - */ - get: operations["GetConsent"]; - /** - * PutConsentByID - * @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service. - * - * - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification. - * - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered. - */ - put: operations["PutConsentByID"]; - /** - * @description Used by PISP, DFSP - * - * The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent. - * For tracing and auditing purposes, the switch should be sure not to delete the consent physically; - * instead, information relating to the consent should be marked as deleted and requests relating to the - * consent should not be honoured. - */ - delete: operations["DeleteConsentByID"]; - /** - * PatchConsentByID - * @description The HTTP request `PATCH /consents/{ID}` is used - * - * - In account linking in the Credential Registration phase. Used by a DFSP - * to notify a PISP a credential has been verified and registered with an - * Auth service. - * - * - In account unlinking by a hub hosted auth service and by DFSPs - * in non-hub hosted scenarios to notify participants of a consent being revoked. - * - * Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario. - * Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario. - */ - patch: operations["PatchConsentByID"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/consents/{ID}/error": { - /** - * NotifyErrorConsents - * @description DFSP responds to the PISP if something went wrong with validating or storing consent. - */ - put: operations["NotifyErrorConsents"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants": { - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - post: operations["Participants1"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/participants/{ID}": { - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - put: operations["PutParticipantsByID"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants/{ID}/error": { - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - put: operations["PutParticipantsByIDAndError"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants/{Type}/{ID}": { - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - get: operations["ParticipantsByTypeAndID"]; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - put: operations["ParticipantsByTypeAndID3"]; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - post: operations["ParticipantsByIDAndType"]; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - delete: operations["ParticipantsByTypeAndID2"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/participants/{Type}/{ID}/error": { - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - put: operations["ParticipantsErrorByTypeAndID"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - }; - "/services/{ServiceType}": { - /** - * GetServicesByServiceType - * @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants - * that support a specified service. - */ - get: operations["GetServicesByServiceType"]; - /** - * PutServicesByServiceType - * @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants - * that support a specified service. - */ - put: operations["PutServicesByServiceType"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ServiceType: components["parameters"]["ServiceType"]; - }; - }; - }; - "/services/{ServiceType}/error": { - /** - * PutServicesByServiceTypeAndError - * @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information - */ - put: operations["PutServicesByServiceTypeAndError"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ServiceType: components["parameters"]["ServiceType"]; - }; - }; - }; - "/thirdpartyRequests/transactions": { - /** - * ThirdpartyRequestsTransactionsPost - * @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP - */ - post: operations["ThirdpartyRequestsTransactionsPost"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/thirdpartyRequests/transactions/{ID}": { - /** - * GetThirdpartyTransactionRequests - * @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the - * retrieval of a third party transaction request. - */ - get: operations["GetThirdpartyTransactionRequests"]; - /** - * UpdateThirdPartyTransactionRequests - * @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about - * the status of a previously requested thirdparty transaction request. - * - * Switch(Thirdparty API Adapter) -> PISP - */ - put: operations["UpdateThirdPartyTransactionRequests"]; - /** - * NotifyThirdpartyTransactionRequests - * @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to - * notify a thirdparty of the outcome of a transaction request. - * - * Switch(Thirdparty API Adapter) -> PISP - */ - patch: operations["NotifyThirdpartyTransactionRequests"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/thirdpartyRequests/transactions/{ID}/error": { - /** - * ThirdpartyTransactionRequestsError - * @description If the server is unable to find the transaction request, or another processing error occurs, - * the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used. - * The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of - * the thirdparty transaction request. - */ - put: operations["ThirdpartyTransactionRequestsError"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/thirdpartyRequests/authorizations": { - /** - * PostThirdpartyRequestsAuthorizations - * @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request. - */ - post: operations["PostThirdpartyRequestsAuthorizations"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/thirdpartyRequests/authorizations/{ID}": { - /** - * GetThirdpartyRequestsAuthorizationsById - * @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating - * to a previously issued authorization request. The *{ID}* in the request should match the - * `authorizationRequestId` which was given when the authorization request was created. - */ - get: operations["GetThirdpartyRequestsAuthorizationsById"]; - /** - * PutThirdpartyRequestsAuthorizationsById - * @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the - * transaction to their user, and request that the client sign the `challenge` field using the credential - * they previously registered. - * - * The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_: - */ - put: operations["PutThirdpartyRequestsAuthorizationsById"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/thirdpartyRequests/authorizations/{ID}/error": { - /** - * PutThirdpartyRequestsAuthorizationsByIdAndError - * @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform - * the other party that something went wrong with a Thirdparty Transaction Authorization Request. - * - * The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't - * match a `transactionRequestId`. - * - * The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}` - * was invalid. - */ - put: operations["PutThirdpartyRequestsAuthorizationsByIdAndError"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/thirdpartyRequests/verifications": { - /** - * PostThirdpartyRequestsVerifications - * @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization. - */ - post: operations["PostThirdpartyRequestsVerifications"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - }; - }; - "/thirdpartyRequests/verifications/{ID}": { - /** - * GetThirdpartyRequestsVerificationsById - * @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get - * information regarding a previously created or requested authorization. The *{ID}* - * in the URI should contain the verification request ID - */ - get: operations["GetThirdpartyRequestsVerificationsById"]; - /** - * PutThirdpartyRequestsVerificationsById - * @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request. - * If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`. - * In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`. - */ - put: operations["PutThirdpartyRequestsVerificationsById"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; - "/thirdpartyRequests/verifications/{ID}/error": { - /** - * PutThirdpartyRequestsVerificationsByIdAndError - * @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform - * the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request. - */ - put: operations["PutThirdpartyRequestsVerificationsByIdAndError"]; - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - }; + "/interface": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */ + post: operations["test"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/accounts/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * GetAccountsByUserId + * @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking. + * + */ + get: operations["GetAccountsByUserId"]; + /** + * UpdateAccountsByUserId + * @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking + * + */ + put: operations["UpdateAccountsByUserId"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/accounts/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * UpdateAccountsByUserIdError + * @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information + * + */ + put: operations["UpdateAccountsByUserIdError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/health": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Health check endpoint + * @description The HTTP request GET /health is used to return the current status of the API. + */ + get: operations["HealthGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Prometheus metrics endpoint + * @description The HTTP request GET /metrics is used to return metrics for the API. + */ + get: operations["MetricsGet"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/consentRequests": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * CreateConsentRequest + * @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more + * accounts owned by a customer of the DFSP for the PISP who sends the request. + * + */ + post: operations["CreateConsentRequest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/consentRequests/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * GetConsentRequestsById + * @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously + * requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the + * request by the PISP when the PISP originated the request. + * + */ + get: operations["GetConsentRequestsById"]; + /** + * UpdateConsentRequest + * @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted, + * and (2) communicate to the PISP which `authChannel` it should use to authenticate their user + * with. + * + * When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all + * the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization + * process may result in additional privileges being granted by the account holder to the PISP. The + * **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a + * particular authorization request. + * + */ + put: operations["UpdateConsentRequest"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * PatchConsentRequest + * @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP. + * + */ + patch: operations["PatchConsentRequest"]; + trace?: never; + }; + "/consentRequests/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * NotifyErrorConsentRequests + * @description DFSP responds to the PISP if something went wrong with validating an OTP or secret. + * + */ + put: operations["NotifyErrorConsentRequests"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/consents": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * PostConsents + * @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to. + * + */ + post: operations["PostConsents"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/consents/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * GetConsent + * @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created. + * + */ + get: operations["GetConsent"]; + /** + * PutConsentByID + * @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service. + * + * - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification. + * - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered. + * + */ + put: operations["PutConsentByID"]; + post?: never; + /** @description Used by PISP, DFSP + * + * The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent. + * For tracing and auditing purposes, the switch should be sure not to delete the consent physically; + * instead, information relating to the consent should be marked as deleted and requests relating to the + * consent should not be honoured. + * */ + delete: operations["DeleteConsentByID"]; + options?: never; + head?: never; + /** + * PatchConsentByID + * @description The HTTP request `PATCH /consents/{ID}` is used + * + * - In account linking in the Credential Registration phase. Used by a DFSP + * to notify a PISP a credential has been verified and registered with an + * Auth service. + * + * - In account unlinking by a hub hosted auth service and by DFSPs + * in non-hub hosted scenarios to notify participants of a consent being revoked. + * + * Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario. + * Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario. + * + */ + patch: operations["PatchConsentByID"]; + trace?: never; + }; + "/consents/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * NotifyErrorConsents + * @description DFSP responds to the PISP if something went wrong with validating or storing consent. + * + */ + put: operations["NotifyErrorConsents"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create bulk participant information + * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. + */ + post: operations["Participants1"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information + * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. + */ + put: operations["PutParticipantsByID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * Return bulk participant information error + * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. + */ + put: operations["PutParticipantsByIDAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * Look up participant information + * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + */ + get: operations["ParticipantsByTypeAndID"]; + /** + * Return participant information + * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. + */ + put: operations["ParticipantsByTypeAndID3"]; + /** + * Create participant information + * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 + */ + post: operations["ParticipantsByIDAndType"]; + /** + * Delete participant information + * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. + * + * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. + */ + delete: operations["ParticipantsByTypeAndID2"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/participants/{Type}/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * Return participant information error + * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. + */ + put: operations["ParticipantsErrorByTypeAndID"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/services/{ServiceType}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ + ServiceType: components["parameters"]["ServiceType"]; + }; + cookie?: never; + }; + /** + * GetServicesByServiceType + * @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants + * that support a specified service. + * + */ + get: operations["GetServicesByServiceType"]; + /** + * PutServicesByServiceType + * @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants + * that support a specified service. + * + */ + put: operations["PutServicesByServiceType"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/services/{ServiceType}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ + ServiceType: components["parameters"]["ServiceType"]; + }; + cookie?: never; + }; + get?: never; + /** + * PutServicesByServiceTypeAndError + * @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information + * + */ + put: operations["PutServicesByServiceTypeAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/transactions": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * ThirdpartyRequestsTransactionsPost + * @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP + */ + post: operations["ThirdpartyRequestsTransactionsPost"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/transactions/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * GetThirdpartyTransactionRequests + * @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the + * retrieval of a third party transaction request. + * + */ + get: operations["GetThirdpartyTransactionRequests"]; + /** + * UpdateThirdPartyTransactionRequests + * @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about + * the status of a previously requested thirdparty transaction request. + * + * Switch(Thirdparty API Adapter) -> PISP + * + */ + put: operations["UpdateThirdPartyTransactionRequests"]; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * NotifyThirdpartyTransactionRequests + * @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to + * notify a thirdparty of the outcome of a transaction request. + * + * Switch(Thirdparty API Adapter) -> PISP + * + */ + patch: operations["NotifyThirdpartyTransactionRequests"]; + trace?: never; + }; + "/thirdpartyRequests/transactions/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * ThirdpartyTransactionRequestsError + * @description If the server is unable to find the transaction request, or another processing error occurs, + * the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used. + * The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of + * the thirdparty transaction request. + * + */ + put: operations["ThirdpartyTransactionRequestsError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/authorizations": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * PostThirdpartyRequestsAuthorizations + * @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request. + * + */ + post: operations["PostThirdpartyRequestsAuthorizations"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/authorizations/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * GetThirdpartyRequestsAuthorizationsById + * @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating + * to a previously issued authorization request. The *{ID}* in the request should match the + * `authorizationRequestId` which was given when the authorization request was created. + * + */ + get: operations["GetThirdpartyRequestsAuthorizationsById"]; + /** + * PutThirdpartyRequestsAuthorizationsById + * @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the + * transaction to their user, and request that the client sign the `challenge` field using the credential + * they previously registered. + * + * The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_: + * + */ + put: operations["PutThirdpartyRequestsAuthorizationsById"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/authorizations/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * PutThirdpartyRequestsAuthorizationsByIdAndError + * @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform + * the other party that something went wrong with a Thirdparty Transaction Authorization Request. + * + * The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't + * match a `transactionRequestId`. + * + * The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}` + * was invalid. + * + */ + put: operations["PutThirdpartyRequestsAuthorizationsByIdAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/verifications": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * PostThirdpartyRequestsVerifications + * @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization. + * + */ + post: operations["PostThirdpartyRequestsVerifications"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/verifications/{ID}": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** + * GetThirdpartyRequestsVerificationsById + * @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get + * information regarding a previously created or requested authorization. The *{ID}* + * in the URI should contain the verification request ID + * + */ + get: operations["GetThirdpartyRequestsVerificationsById"]; + /** + * PutThirdpartyRequestsVerificationsById + * @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request. + * If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`. + * In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`. + */ + put: operations["PutThirdpartyRequestsVerificationsById"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/thirdpartyRequests/verifications/{ID}/error": { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + get?: never; + /** + * PutThirdpartyRequestsVerificationsByIdAndError + * @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform + * the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request. + * + */ + put: operations["PutThirdpartyRequestsVerificationsByIdAndError"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; } - export type webhooks = Record; - export interface components { - schemas: { - /** - * PartyIdType - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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). - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - 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. - * - CONSENT - A Consent represents an agreement between a PISP, a Customer and - * a DFSP which allows the PISP permission to perform actions on behalf of the - * customer. A Consent has an authoritative source: either the DFSP who issued - * the Consent, or an Auth Service which administers the Consent. - * - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP, - * a DFSP, and a specific Customer's account at the DFSP. The content of the link - * is created by the DFSP at the time when it gives permission to the PISP for - * specific access to a given account. - * - * @example PERSONAL_ID - * @enum {string} - */ - PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK"; - /** - * PartyIdentifier - * @description Identifier of the Party. - * @example 16135551212 - */ - PartyIdentifier: string; - /** - * PartySubIdOrType - * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. - */ - PartySubIdOrType: string; - /** - * FspId - * @description FSP identifier. - */ - FspId: string; - /** - * ExtensionKey - * @description Extension key. - */ - ExtensionKey: string; - /** - * ExtensionValue - * @description Extension value. - */ - ExtensionValue: string; - /** - * Extension - * @description Data model for the complex type Extension. - */ - Extension: { - key: components["schemas"]["ExtensionKey"]; - value: components["schemas"]["ExtensionValue"]; - }; - /** - * ExtensionList - * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. - */ - ExtensionList: { - /** @description Number of Extension elements. */ - extension: components["schemas"]["Extension"][]; - }; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. - */ - PartyIdInfo: { - partyIdType: components["schemas"]["PartyIdType"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ErrorCode - * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. - * @example 5100 - */ - ErrorCode: string; - /** - * ErrorDescription - * @description Error description string. - */ - ErrorDescription: string; - /** - * ErrorInformation - * @description Data model for the complex type ErrorInformation. - */ - ErrorInformation: { - errorCode: components["schemas"]["ErrorCode"]; - errorDescription: components["schemas"]["ErrorDescription"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * PartyResult - * @description Data model for the complex type PartyResult. - */ - PartyResult: { - partyId: components["schemas"]["PartyIdInfo"]; - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * Currency - * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. - * @enum {string} - */ - Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; - /** - * ParticipantsIDPutResponse - * @description The object sent in the PUT /participants/{ID} callback. - */ - ParticipantsIDPutResponse: { - /** @description List of PartyResult elements that were either created or failed to be created. */ - partyList: components["schemas"]["PartyResult"][]; - currency?: components["schemas"]["Currency"]; - }; - /** - * MerchantClassificationCode - * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. - */ - MerchantClassificationCode: string; - /** - * PartyName - * @description Name of the Party. Could be a real name or a nickname. - */ - PartyName: string; - /** - * FirstName - * @description First name of the Party (Name Type). - * @example Henrik - */ - FirstName: string; - /** - * MiddleName - * @description Middle name of the Party (Name Type). - * @example Johannes - */ - MiddleName: string; - /** - * LastName - * @description Last name of the Party (Name Type). - * @example Karlsson - */ - LastName: string; - /** - * PartyComplexName - * @description Data model for the complex type PartyComplexName. - */ - PartyComplexName: { - firstName?: components["schemas"]["FirstName"]; - middleName?: components["schemas"]["MiddleName"]; - lastName?: components["schemas"]["LastName"]; - }; - /** - * DateofBirth (type Date) - * @description Date of Birth of the Party. - * @example 1966-06-16 - */ - DateOfBirth: string; - /** - * PartyPersonalInfo - * @description Data model for the complex type PartyPersonalInfo. - */ - PartyPersonalInfo: { - complexName?: components["schemas"]["PartyComplexName"]; - dateOfBirth?: components["schemas"]["DateOfBirth"]; - }; - /** - * Party - * @description Data model for the complex type Party. - */ - Party: { - partyIdInfo: components["schemas"]["PartyIdInfo"]; - merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; - name?: components["schemas"]["PartyName"]; - personalInfo?: components["schemas"]["PartyPersonalInfo"]; - }; - /** - * PartiesTypeIDPutResponse - * @description The object sent in the PUT /parties/{Type}/{ID} callback. - * - * This is a variant based on FSPIOP `PartiesTypeIDPutResponse` specification. - * Main difference being that it returns a `Party` with the newly added - * `accounts` property. - */ - PartiesTypeIDPutResponse: { - party: components["schemas"]["Party"]; - }; - /** - * Amount - * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. - * @example 123.45 - */ - Amount: string; - /** - * Money - * @description Data model for the complex type Money. - */ - Money: { - currency: components["schemas"]["Currency"]; - amount: components["schemas"]["Amount"]; - }; - /** - * DateTime - * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). - * @example 2016-05-24T08:38:08.699-04:00 - */ - DateTime: string; - /** - * Latitude - * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +45.4215 - */ - Latitude: string; - /** - * Longitude - * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. - * @example +75.6972 - */ - Longitude: string; - /** - * GeoCode - * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. - */ - GeoCode: { - latitude: components["schemas"]["Latitude"]; - longitude: components["schemas"]["Longitude"]; - }; - /** - * IlpPacket - * @description Information for recipient (transport layer information). - * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA - */ - IlpPacket: string; - /** - * IlpCondition - * @description Condition that must be attached to the transfer by the Payer. - */ - IlpCondition: string; - /** - * QuotesIDPutResponse - * @description The object sent in the PUT /quotes/{ID} callback. - */ - QuotesIDPutResponse: { - transferAmount: components["schemas"]["Money"]; - payeeReceiveAmount?: components["schemas"]["Money"]; - payeeFspFee?: components["schemas"]["Money"]; - payeeFspCommission?: components["schemas"]["Money"]; - expiration: components["schemas"]["DateTime"]; - geoCode?: components["schemas"]["GeoCode"]; - ilpPacket: components["schemas"]["IlpPacket"]; - condition: components["schemas"]["IlpCondition"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * TransactionRequestState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. - * - PENDING - Payer FSP has sent the transaction request to the Payer. - * - ACCEPTED - Payer has approved the transaction. - * - REJECTED - Payer has rejected the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; - /** - * TransactionState - * @description Below are the allowed values for the enumeration. - * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. - * - PENDING - Payee FSP has validated the transaction. - * - COMPLETED - Payee FSP has successfully performed the transaction. - * - REJECTED - Payee FSP has failed to perform the transaction. - * @example RECEIVED - * @enum {string} - */ - TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; - /** - * ThirdpartyRequestsTransactionsIDPatchResponse - * @description Used by: DFSP - * The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer. - * This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource. - * The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations - */ - ThirdpartyRequestsTransactionsIDPatchResponse: { - completedTimestamp?: components["schemas"]["DateTime"]; - transactionRequestState: components["schemas"]["TransactionRequestState"]; - transactionState: components["schemas"]["TransactionState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * AuthorizationResponseType - * @description Enum containing authorization response information; if the customer - * accepted the terms of the transfer, or rejected the terms. - * - * @enum {string} - */ - AuthorizationResponseType: "ACCEPTED" | "REJECTED"; - /** - * ConsentStatusIssued - * @description Allowed values for the enumeration ConsentStatus - * - ISSUED - The consent has been issued by the DFSP - * @enum {string} - */ - ConsentStatusIssued: "ISSUED"; - /** - * IlpFulfilment - * @description Fulfilment that must be attached to the transfer by the Payee. - * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 - */ - IlpFulfilment: string; - /** - * Integer - * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. - */ - Integer: string; - /** - * Note - * @description Memo assigned to transaction. - * @example Note sent to Payee. - */ - Note: string; - /** - * PartyIdTypeTPLink - * @description - THIRD_PARTY_LINK - is the DFSP's internal reference which allows DFSP to find out the corresponding consent - * - * @example PERSONAL_ID - * @enum {string} - */ - PartyIdTypeTPLink: "THIRD_PARTY_LINK"; - /** - * PartyIdInfo - * @description Data model for the complex type PartyIdInfo. - */ - PartyIdInfoTPLink: { - partyIdType: components["schemas"]["PartyIdTypeTPLink"]; - partyIdentifier: components["schemas"]["PartyIdentifier"]; - partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; - fspId?: components["schemas"]["FspId"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ServiceType - * @description The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource. - * Below are the allowed values for the enumeration ServiceType - THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE - Participants which provide Authentication Services. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype - * @enum {string} - */ - ServiceType: "THIRD_PARTY_DFSP" | "PISP" | "AUTH_SERVICE"; - /** - * CorrelationId - * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - CorrelationId: string; - /** - * ParticipantsPostRequest - * @description The object sent in the POST /participants request. - */ - ParticipantsPostRequest: { - requestId: components["schemas"]["CorrelationId"]; - /** - * @description List of PartyIdInfo elements that the client would like to update - * or create FSP information about. - */ - partyList: components["schemas"]["PartyIdInfo"][]; - currency?: components["schemas"]["Currency"]; - }; - /** - * AmountType - * @description Below are the allowed values for the enumeration AmountType. - * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. - * - 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. - * @example RECEIVE - * @enum {string} - */ - AmountType: "SEND" | "RECEIVE"; - /** - * TransactionScenario - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. - * - 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. - * - REFUND - Used for performing a refund of transaction. - * @example DEPOSIT - * @enum {string} - */ - TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; - /** - * TransactionSubScenario - * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). - * @example LOCALLY_DEFINED_SUBSCENARIO - */ - TransactionSubScenario: string; - /** - * TransactionInitiator - * @description Below are the allowed values for the enumeration. - * - 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. - * - 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. - * @example PAYEE - * @enum {string} - */ - TransactionInitiator: "PAYER" | "PAYEE"; - /** - * TransactionInitiatorType - * @description Below are the allowed values for the enumeration. - * - CONSUMER - Consumer is the initiator of the transaction. - * - AGENT - Agent is the initiator of the transaction. - * - BUSINESS - Business is the initiator of the transaction. - * - DEVICE - Device is the initiator of the transaction. - * @example CONSUMER - * @enum {string} - */ - TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; - /** - * RefundReason - * @description Reason for the refund. - * @example Free text indicating reason for the refund. - */ - RefundReason: string; - /** - * Refund - * @description Data model for the complex type Refund. - */ - Refund: { - originalTransactionId: components["schemas"]["CorrelationId"]; - refundReason?: components["schemas"]["RefundReason"]; - }; - /** - * BalanceOfPayments - * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. - * @example 123 - */ - BalanceOfPayments: string; - /** - * TransactionType - * @description Data model for the complex type TransactionType. - */ - TransactionType: { - scenario: components["schemas"]["TransactionScenario"]; - subScenario?: components["schemas"]["TransactionSubScenario"]; - initiator: components["schemas"]["TransactionInitiator"]; - initiatorType: components["schemas"]["TransactionInitiatorType"]; - refundInfo?: components["schemas"]["Refund"]; - balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; - }; - /** - * QuotesPostRequest - * @description The object sent in the POST /quotes request. - */ - QuotesPostRequest: { - /** - * @description Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. - * @example b51ec534-ee48-4575-b6a9-ead2955b8069 - */ - quoteId: components["schemas"]["CorrelationId"]; - /** - * @description Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. - * @example a8323bc6-c228-4df2-ae82-e5a997baf899 - */ - transactionId: components["schemas"]["CorrelationId"]; - /** - * @description Identifies an optional previously-sent transaction request. - * @example a8323bc6-c228-4df2-ae82-e5a997baf890 - */ - transactionRequestId?: components["schemas"]["CorrelationId"]; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - /** @description Information about the Payer in the proposed financial transaction. */ - payer: components["schemas"]["Party"]; - /** - * @description SEND for send amount, RECEIVE for receive amount. - * @example SEND - */ - amountType: components["schemas"]["AmountType"]; - /** @description Depending on amountType - If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction. If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive any fees. The amount is not updated by any of the participating entities. */ - amount: components["schemas"]["Money"]; - /** @description The fees in the transaction. The fees element should be empty if fees should be non-disclosed. The fees element should be non-empty if fees should be disclosed. */ - fees?: components["schemas"]["Money"]; - /** @description Type of transaction for which the quote is requested. */ - transactionType: components["schemas"]["TransactionType"]; - /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ - geoCode?: components["schemas"]["GeoCode"]; - /** - * @description A memo that will be attached to the transaction. - * @example Free-text memo. - */ - note?: components["schemas"]["Note"]; - /** - * @description Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit. - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration?: components["schemas"]["DateTime"]; - /** @description Optional extension, specific to deployment. */ - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ErrorInformationResponse - * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. - */ - ErrorInformationResponse: { - errorInformation?: components["schemas"]["ErrorInformation"]; - }; - /** - * Name - * @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. - * - * 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 ( ). - * - * **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. - */ - Name: string; - /** - * AccountAddress - * @description The AccountAddress data type is a variable length string with a maximum size of 1023 characters and consists of: - * Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.) - * - Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character - * An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain. - * IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case). - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress - */ - AccountAddress: string; - /** - * Account - * @description Data model for the complex type Account. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account - */ - Account: { - accountNickname: components["schemas"]["Name"]; - address: components["schemas"]["AccountAddress"]; - currency: components["schemas"]["Currency"]; - }; - /** - * AccountList - * @description The AccountList data model is used to hold information about the accounts that a party controls. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist - */ - AccountList: components["schemas"]["Account"][]; - /** - * AccountsIDPutResponse - * @description Callback and data model information for GET /accounts/{ID}: - * Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body - * The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid - */ - AccountsIDPutResponse: { - accounts: components["schemas"]["AccountList"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ErrorInformationObject - * @description Data model for the complex type object that contains ErrorInformation. - */ - ErrorInformationObject: { - errorInformation: components["schemas"]["ErrorInformation"]; - }; - /** - * ScopeAction - * @description The ScopeAction element contains an access type which a PISP can request - * from a DFSP, or which a DFSP can grant to a PISP. - * It must be a member of the appropriate enumeration. - * - * - ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account - * - ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP - * - ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account - * - * @enum {string} - */ - ScopeAction: "ACCOUNTS_GET_BALANCE" | "ACCOUNTS_TRANSFER" | "ACCOUNTS_STATEMENT"; - /** - * Scope - * @description The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope - */ - Scope: { - address: components["schemas"]["AccountAddress"]; - actions: components["schemas"]["ScopeAction"][]; - }; - /** - * ConsentRequestChannelType - * @description The auth channel being used for the consent request. - * - WEB - DFSP can support authorization via a web-based login. - * - OTP - DFSP can support authorization via a One Time PIN. - * - * @enum {string} - */ - ConsentRequestChannelType: "WEB" | "OTP"; - /** - * Uri - * @description The API data type Uri is a JSON string in a canonical format that is restricted by a regular expression for interoperability reasons. - */ - Uri: string; - /** - * ConsentRequestsPostRequest - * @description Used by: PISP - * The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request. - * Callback and data model for POST /consentRequests: - * Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests - */ - ConsentRequestsPostRequest: { - consentRequestId: components["schemas"]["CorrelationId"]; - /** @description The identifier used in the **GET /accounts/**_{ID}_. Used by the DFSP to correlate an account lookup to a `consentRequest` */ - userId: string; - scopes: components["schemas"]["Scope"][]; - authChannels: components["schemas"]["ConsentRequestChannelType"][]; - callbackUri: components["schemas"]["Uri"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ConsentRequestChannelTypeWeb - * @description The web auth channel being used for `PUT /consentRequest/{ID}` request. - * - * @enum {string} - */ - ConsentRequestChannelTypeWeb: "WEB"; - /** - * ConsentRequestsIDPutResponseWeb - * @description The object sent in a `PUT /consentRequests/{ID}` request. - * - * Schema used in the request consent phase of the account linking web flow, - * the result is the PISP being instructed on a specific URL where this - * supposed user should be redirected. This URL should be a place where - * the user can prove their identity (e.g., by logging in). - */ - ConsentRequestsIDPutResponseWeb: { - scopes: components["schemas"]["Scope"][]; - authChannels: components["schemas"]["ConsentRequestChannelTypeWeb"][]; - callbackUri: components["schemas"]["Uri"]; - authUri: components["schemas"]["Uri"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ConsentRequestChannelTypeOTP - * @description The OTP auth channel being used for `PUT /consentRequests/{ID}` request. - * - * @enum {string} - */ - ConsentRequestChannelTypeOTP: "OTP"; - /** - * ConsentRequestsIDPutResponseOTP - * @description The object sent in a `PUT /consentRequests/{ID}` request. - * - * Schema used in the request consent phase of the account linking OTP/SMS flow. - */ - ConsentRequestsIDPutResponseOTP: { - scopes: components["schemas"]["Scope"][]; - authChannels: components["schemas"]["ConsentRequestChannelTypeOTP"][]; - callbackUri?: components["schemas"]["Uri"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ - BinaryString: string; - /** - * ConsentRequestsIDPatchRequest - * @description Used by: PISP - * After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid - */ - ConsentRequestsIDPatchRequest: { - authToken: components["schemas"]["BinaryString"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * CredentialType - * @description The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype - * @enum {string} - */ - CredentialType: "FIDO" | "GENERIC"; - /** - * CredentialStatusPending - * @description The status of the Credential. - * - "PENDING" - The credential has been created, but has not been verified - * - * @enum {string} - */ - CredentialStatusPending: "PENDING"; - /** - * GenericCredential - * @description A publicKey + signature of a challenge for a generic public/private keypair. - */ - GenericCredential: { - publicKey: components["schemas"]["BinaryString"]; - signature: components["schemas"]["BinaryString"]; - }; - /** - * FIDOPublicKeyCredentialAttestation - * @description A data model representing a FIDO Attestation result. Derived from - * [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential). - * - * The `PublicKeyCredential` interface represents the below fields with - * a Type of Javascript [ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer). - * For this API, we represent ArrayBuffers as base64 encoded utf-8 strings. - */ - FIDOPublicKeyCredentialAttestation: { - /** - * @description credential id: identifier of pair of keys, base64 encoded - * https://w3c.github.io/webauthn/#ref-for-dom-credential-id - */ - id: string; - /** @description raw credential id: identifier of pair of keys, base64 encoded */ - rawId?: string; - /** @description AuthenticatorAttestationResponse */ - response: { - /** @description JSON string with client data */ - clientDataJSON: string; - /** @description CBOR.encoded attestation object */ - attestationObject: string; - }; - /** - * @description response type, we need only the type of public-key - * @enum {string} - */ - type: "public-key"; - }; - /** - * SignedCredential - * @description A credential used to allow a user to prove their identity and access - * to an account with a DFSP. - * - * SignedCredential is a special formatting of the credential to allow us to be - * more explicit about the `status` field - it should only ever be PENDING when - * updating a credential. - */ - SignedCredential: { - credentialType: components["schemas"]["CredentialType"]; - status: components["schemas"]["CredentialStatusPending"]; - genericPayload?: components["schemas"]["GenericCredential"]; - fidoPayload?: components["schemas"]["FIDOPublicKeyCredentialAttestation"]; - }; - /** - * ConsentStatus - * @description Allowed values for the enumeration ConsentStatus - * - ISSUED - The consent has been issued by the DFSP - * - REVOKED - The consent has been revoked - * @enum {string} - */ - ConsentStatus: "ISSUED" | "REVOKED"; - /** - * ConsentPostRequestAUTH - * @description The object sent in a `POST /consents` request to the Auth-Service - * by a DFSP to store registered Consent and credential - */ - ConsentsPostRequestAUTH: { - /** - * @description Common ID between the PISP and FSP for the Consent object - * determined by the DFSP who creates the Consent. - */ - consentId: components["schemas"]["CorrelationId"]; - consentRequestId?: components["schemas"]["CorrelationId"]; - scopes: components["schemas"]["Scope"][]; - credential: components["schemas"]["SignedCredential"]; - status: components["schemas"]["ConsentStatus"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ConsentPostRequestPISP - * @description The provisional Consent object sent by the DFSP in `POST /consents`. - */ - ConsentsPostRequestPISP: { - /** - * @description Common ID between the PISP and the Payer DFSP for the consent object. The ID - * should be reused for re-sends of the same consent. A new ID should be generated - * for each new consent. - */ - consentId: components["schemas"]["CorrelationId"]; - /** @description The ID given to the original consent request on which this consent is based. */ - consentRequestId: components["schemas"]["CorrelationId"]; - scopes: components["schemas"]["Scope"][]; - status: components["schemas"]["ConsentStatus"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ConsentsIDPutResponseSigned - * @description The HTTP request `PUT /consents/{ID}` is used by the PISP to update a Consent with a signed challenge and register a credential. - * Called by a `PISP` to after signing a challenge. Sent to a DFSP for verification. - */ - ConsentsIDPutResponseSigned: { - status?: components["schemas"]["ConsentStatusIssued"]; - scopes: components["schemas"]["Scope"][]; - credential: components["schemas"]["SignedCredential"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * CredentialStatusVerified - * @description The status of the Credential. - * - "VERIFIED" - The Credential is valid and verified. - * - * @enum {string} - */ - CredentialStatusVerified: "VERIFIED"; - /** - * VerifiedCredential - * @description A credential used to allow a user to prove their identity and access - * to an account with a DFSP. - * - * VerifiedCredential is a special formatting of Credential to allow us to be - * more explicit about the `status` field - it should only ever be VERIFIED when - * updating a credential. - */ - VerifiedCredential: { - credentialType: components["schemas"]["CredentialType"]; - status: components["schemas"]["CredentialStatusVerified"]; - genericPayload?: components["schemas"]["GenericCredential"]; - fidoPayload?: components["schemas"]["FIDOPublicKeyCredentialAttestation"]; - }; - /** - * ConsentsIDPutResponseVerified - * @description The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified. - * Called by a `auth-service` to notify a DFSP that a credential has been verified and registered. - */ - ConsentsIDPutResponseVerified: { - status?: components["schemas"]["ConsentStatusIssued"]; - scopes: components["schemas"]["Scope"][]; - credential: components["schemas"]["VerifiedCredential"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ConsentsIDPatchResponseVerified - * @description PATCH /consents/{ID} request object. - * - * Sent by the DFSP to the PISP when a consent is issued and verified. - * Used in the "Register Credential" part of the Account linking flow. - */ - ConsentsIDPatchResponseVerified: { - credential: { - status: components["schemas"]["CredentialStatusVerified"]; - }; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ConsentStatusRevoked - * @description Allowed values for the enumeration ConsentStatus - * - REVOKED - The consent has been revoked - * @enum {string} - */ - ConsentStatusRevoked: "REVOKED"; - /** - * ConsentsIDPatchResponseRevoked - * @description PATCH /consents/{ID} request object. - * - * Sent to both the PISP and DFSP when a consent is revoked. - * Used in the "Unlinking" part of the Account Unlinking flow. - */ - ConsentsIDPatchResponseRevoked: { - status: components["schemas"]["ConsentStatusRevoked"]; - revokedAt: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ParticipantsTypeIDPutResponse - * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. - */ - ParticipantsTypeIDPutResponse: { - fspId?: components["schemas"]["FspId"]; - }; - /** - * ParticipantsTypeIDSubIDPostRequest - * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes. - */ - ParticipantsTypeIDSubIDPostRequest: { - fspId: components["schemas"]["FspId"]; - currency?: components["schemas"]["Currency"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ServicesServiceTypePutResponse - * @description Used by: Switch - * The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup. - * Callback and data model information for GET /services/{ServiceType}: - * Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype - */ - ServicesServiceTypePutResponse: { - providers: components["schemas"]["FspId"][]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ThirdpartyRequestsTransactionsPostRequest - * @description Used by: PISP - * The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request. - * Callback and data model information for POST /thirdpartyRequests/transactions: - * Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions - */ - ThirdpartyRequestsTransactionsPostRequest: { - /** @description Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request. */ - transactionRequestId: components["schemas"]["CorrelationId"]; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - /** @description Information about the Payer in the proposed financial transaction. */ - payer: components["schemas"]["PartyIdInfo"]; - /** @description SEND for sendAmount, RECEIVE for receiveAmount. */ - amountType: components["schemas"]["AmountType"]; - /** @description Requested amount to be transferred from the Payer to Payee. */ - amount: components["schemas"]["Money"]; - /** @description Type of transaction. */ - transactionType: components["schemas"]["TransactionType"]; - /** @description A memo that will be attached to the transaction. */ - note?: string; - /** - * @description Date and time until when the transaction request is valid. It can be set to get a quick failure in case the peer FSP takes too long to respond. - * - * @example 2016-05-24T08:38:08.699-04:00 - */ - expiration: string; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ThirdpartyRequestsTransactionsIDPutResponse - * @description Used by: DFSP - * After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid - */ - ThirdpartyRequestsTransactionsIDPutResponse: { - transactionId?: components["schemas"]["CorrelationId"]; - transactionRequestState: components["schemas"]["TransactionRequestState"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ThirdpartyRequestsAuthorizationsPostRequest - * @description Used by: DFSP - * The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request. - * Callback and data model information for POST /thirdpartyRequests/authorizations: - * Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations - */ - ThirdpartyRequestsAuthorizationsPostRequest: { - authorizationRequestId: components["schemas"]["CorrelationId"]; - transactionRequestId: components["schemas"]["CorrelationId"]; - /** @description The challenge that the PISP's client is to sign */ - challenge: string; - /** @description The amount that will be debited from the sending customer's account as a consequence of the transaction. */ - transferAmount: components["schemas"]["Money"]; - /** @description The amount that will be credited to the receiving customer's account as a consequence of the transaction. */ - payeeReceiveAmount: components["schemas"]["Money"]; - /** @description The amount of fees that the paying customer will be charged as part of the transaction. */ - fees: components["schemas"]["Money"]; - /** @description Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction. */ - payer: components["schemas"]["PartyIdInfo"]; - /** @description Information about the Payee in the proposed financial transaction. */ - payee: components["schemas"]["Party"]; - transactionType: components["schemas"]["TransactionType"]; - /** @description The time by which the transfer must be completed, set by the payee DFSP. */ - expiration: components["schemas"]["DateTime"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * AuthorizationResponseTypeRejected - * @description The customer rejected the terms of the transfer. - * - * @enum {string} - */ - AuthorizationResponseTypeRejected: "REJECTED"; - /** - * ThirdpartyRequestsAuthorizationsIDPutResponseRejected - * @description The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback. - */ - ThirdpartyRequestsAuthorizationsIDPutResponseRejected: { - responseType: components["schemas"]["AuthorizationResponseTypeRejected"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * AuthorizationResponseType - * @description The customer accepted the terms of the transfer - * - * @enum {string} - */ - AuthorizationResponseTypeAccepted: "ACCEPTED"; - /** - * SignedPayloadTypeFIDO - * @description Describes a challenge that has been signed with FIDO Attestation flows - * @enum {string} - */ - SignedPayloadTypeFIDO: "FIDO"; - /** - * FIDOPublicKeyCredentialAssertion - * @description A data model representing a FIDO Assertion result. - * Derived from PublicKeyCredential Interface in WebAuthN. - * - * The PublicKeyCredential interface represents the below fields with a Type of - * Javascript ArrayBuffer. - * For this API, we represent ArrayBuffers as base64 encoded utf-8 strings. - * - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion - */ - FIDOPublicKeyCredentialAssertion: { - /** - * @description credential id: identifier of pair of keys, base64 encoded - * https://w3c.github.io/webauthn/#ref-for-dom-credential-id - */ - id: string; - /** @description raw credential id: identifier of pair of keys, base64 encoded. */ - rawId: string; - /** @description AuthenticatorAssertionResponse */ - response: { - /** @description Authenticator data object. */ - authenticatorData: string; - /** @description JSON string with client data. */ - clientDataJSON: string; - /** @description The signature generated by the private key associated with this credential. */ - signature: string; - /** - * @description This field is optionally provided by the authenticator, and - * represents the user.id that was supplied during registration. - */ - userHandle?: string; - }; - /** - * @description response type, we need only the type of public-key - * @enum {string} - */ - type: "public-key"; - }; - /** SignedPayloadFIDO */ - SignedPayloadFIDO: { - signedPayloadType: components["schemas"]["SignedPayloadTypeFIDO"]; - fidoSignedPayload: components["schemas"]["FIDOPublicKeyCredentialAssertion"]; - }; - /** - * ThirdpartyRequestsAuthorizationsIDPutResponseFIDO - * @description The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback. - */ - ThirdpartyRequestsAuthorizationsIDPutResponseFIDO: { - responseType: components["schemas"]["AuthorizationResponseTypeAccepted"]; - signedPayload: components["schemas"]["SignedPayloadFIDO"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * SignedPayloadTypeGeneric - * @description Describes a challenge that has been signed with a private key - * @enum {string} - */ - SignedPayloadTypeGeneric: "GENERIC"; - /** SignedPayloadGeneric */ - SignedPayloadGeneric: { - signedPayloadType: components["schemas"]["SignedPayloadTypeGeneric"]; - genericSignedPayload: components["schemas"]["BinaryString"]; - }; - /** - * ThirdpartyRequestsAuthorizationsIDPutResponseGeneric - * @description The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback. - */ - ThirdpartyRequestsAuthorizationsIDPutResponseGeneric: { - responseType: components["schemas"]["AuthorizationResponseTypeAccepted"]; - signedPayload: components["schemas"]["SignedPayloadGeneric"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ThirdpartyRequestsVerificationsPostRequestFIDO - * @description The object sent in the POST /thirdpartyRequests/verifications request. - */ - ThirdpartyRequestsVerificationsPostRequestFIDO: { - verificationRequestId: components["schemas"]["CorrelationId"]; - /** @description Base64 encoded bytes - The challenge generated by the DFSP. */ - challenge: string; - /** - * @description The id of the stored consent object that contains the credential with which to verify - * the signed challenge against. - */ - consentId: components["schemas"]["CorrelationId"]; - signedPayloadType: components["schemas"]["SignedPayloadTypeFIDO"]; - fidoSignedPayload: components["schemas"]["FIDOPublicKeyCredentialAssertion"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * ThirdpartyRequestsVerificationsPostRequestGeneric - * @description The object sent in the POST /thirdpartyRequests/verifications request. - */ - ThirdpartyRequestsVerificationsPostRequestGeneric: { - verificationRequestId: components["schemas"]["CorrelationId"]; - /** @description Base64 encoded bytes - The challenge generated by the DFSP. */ - challenge: string; - /** - * @description The id of the stored consent object that contains the credential with which to verify - * the signed challenge against. - */ - consentId: components["schemas"]["CorrelationId"]; - signedPayloadType: components["schemas"]["SignedPayloadTypeGeneric"]; - genericSignedPayload: components["schemas"]["BinaryString"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - /** - * AuthenticationResponse - * @description The AuthenticationResponse enumeration describes the result of authenticating verification request. - * Below are the allowed values for the enumeration AuthenticationResponse. - VERIFIED - The challenge was correctly signed. - * @enum {string} - */ - AuthenticationResponse: "VERIFIED"; - /** - * ThirdpartyRequestsVerificationsIDPutResponse - * @description Used by: Auth Service - * The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}. - * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid - */ - ThirdpartyRequestsVerificationsIDPutResponse: { - authenticationResponse: components["schemas"]["AuthenticationResponse"]; - extensionList?: components["schemas"]["ExtensionList"]; - }; - }; - responses: { - /** @description OK */ - 200: { - content: never; - }; - /** @description Accepted */ - 202: { - content: never; - }; - /** @description Bad Request */ - 400: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Unauthorized */ - 401: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Forbidden */ - 403: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Found */ - 404: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Method Not Allowed */ - 405: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Acceptable */ - 406: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Not Implemented */ - 501: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - /** @description Service Unavailable */ - 503: { - headers: { - "Content-Length": components["headers"]["Content-Length"]; - "Content-Type": components["headers"]["Content-Type"]; - }; - content: { - "application/json": components["schemas"]["ErrorInformationResponse"]; - }; - }; - }; - parameters: { - /** @description The identifier value. */ - ID: string; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - /** @description The `Date` header field indicates the date when the request was sent. */ - Date: string; - /** - * @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. - * - * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. - */ - "X-Forwarded-For"?: string; - /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ - "FSPIOP-Source": string; - /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ - "FSPIOP-Destination"?: string; - /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ - "FSPIOP-Encryption"?: string; - /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ - "FSPIOP-Signature"?: string; - /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-URI"?: string; - /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ - "FSPIOP-HTTP-Method"?: string; - /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ - Accept: string; - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length"?: number; - /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ - Type: string; - /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ - ServiceType: string; - }; - requestBodies: never; - headers: { - /** - * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. - * - * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). - */ - "Content-Length": number; - /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ - "Content-Type": string; - }; - pathItems: never; -} - -export type $defs = Record; - -export type external = Record; - -export interface operations { - - /** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */ - test: { - requestBody?: { - content: { - "application/json": components["schemas"]["ParticipantsIDPutResponse"] | components["schemas"]["PartiesTypeIDPutResponse"] | components["schemas"]["QuotesIDPutResponse"] | components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"] | components["schemas"]["AuthorizationResponseType"] | components["schemas"]["ConsentStatusIssued"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["Integer"] | components["schemas"]["Note"] | components["schemas"]["PartyIdInfoTPLink"] | components["schemas"]["PartyResult"] | components["schemas"]["ServiceType"] | components["schemas"]["ParticipantsPostRequest"] | components["schemas"]["QuotesPostRequest"]; - }; - }; - responses: { - /** @description Ok */ - 200: { - content: never; - }; - }; - }; - /** - * GetAccountsByUserId - * @description The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking. - */ - GetAccountsByUserId: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * UpdateAccountsByUserId - * @description The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking - */ - UpdateAccountsByUserId: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - /** - * @example [ - * { - * "accountNickname": "dfspa.user.nickname1", - * "id": "dfspa.username.1234", - * "currency": "ZAR" - * }, - * { - * "accountNickname": "dfspa.user.nickname2", - * "id": "dfspa.username.5678", - * "currency": "USD" - * } - * ] - */ - "application/json": components["schemas"]["AccountsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * UpdateAccountsByUserIdError - * @description The HTTP request `PUT /accounts/{ID}/error` is used to return error information - */ - UpdateAccountsByUserIdError: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Health check endpoint - * @description The HTTP request GET /health is used to return the current status of the API. - */ - HealthGet: { - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Prometheus metrics endpoint - * @description The HTTP request GET /metrics is used to return metrics for the API. - */ - MetricsGet: { - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * CreateConsentRequest - * @description The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more - * accounts owned by a customer of the DFSP for the PISP who sends the request. - */ - CreateConsentRequest: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - /** @description The consentRequest to create */ - requestBody: { - content: { - "application/json": components["schemas"]["ConsentRequestsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * GetConsentRequestsById - * @description The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously - * requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the - * request by the PISP when the PISP originated the request. - */ - GetConsentRequestsById: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * UpdateConsentRequest - * @description A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted, - * and (2) communicate to the PISP which `authChannel` it should use to authenticate their user - * with. - * - * When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all - * the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization - * process may result in additional privileges being granted by the account holder to the PISP. The - * **PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a - * particular authorization request. - */ - UpdateConsentRequest: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ConsentRequestsIDPutResponseWeb"] | components["schemas"]["ConsentRequestsIDPutResponseOTP"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PatchConsentRequest - * @description After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP. - */ - PatchConsentRequest: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ConsentRequestsIDPatchRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * NotifyErrorConsentRequests - * @description DFSP responds to the PISP if something went wrong with validating an OTP or secret. - */ - NotifyErrorConsentRequests: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Error information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PostConsents - * @description The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to. - */ - PostConsents: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ConsentsPostRequestAUTH"] | components["schemas"]["ConsentsPostRequestPISP"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * GetConsent - * @description The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created. - */ - GetConsent: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutConsentByID - * @description The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service. - * - * - Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification. - * - Called by a `auth-service` to notify a DFSP that a credential has been verified and registered. - */ - PutConsentByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ConsentsIDPutResponseSigned"] | components["schemas"]["ConsentsIDPutResponseVerified"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * @description Used by PISP, DFSP - * - * The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent. - * For tracing and auditing purposes, the switch should be sure not to delete the consent physically; - * instead, information relating to the consent should be marked as deleted and requests relating to the - * consent should not be honoured. - */ - DeleteConsentByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PatchConsentByID - * @description The HTTP request `PATCH /consents/{ID}` is used - * - * - In account linking in the Credential Registration phase. Used by a DFSP - * to notify a PISP a credential has been verified and registered with an - * Auth service. - * - * - In account unlinking by a hub hosted auth service and by DFSPs - * in non-hub hosted scenarios to notify participants of a consent being revoked. - * - * Called by a `auth-service` to notify a PISP and DFSP of consent status in hub hosted scenario. - * Called by a `DFSP` to notify a PISP of consent status in non-hub hosted scenario. - */ - PatchConsentByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ConsentsIDPatchResponseVerified"] | components["schemas"]["ConsentsIDPatchResponseRevoked"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * NotifyErrorConsents - * @description DFSP responds to the PISP if something went wrong with validating or storing consent. - */ - NotifyErrorConsents: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Error information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create bulk participant information - * @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency. - */ - Participants1: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information - * @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities. - */ - PutParticipantsByID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return bulk participant information error - * @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information. - */ - PutParticipantsByIDAndError: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Look up participant information - * @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - */ - ParticipantsByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information - * @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party. - */ - ParticipantsByTypeAndID3: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Create participant information - * @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1 - */ - ParticipantsByIDAndType: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Participant information to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Delete participant information - * @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency. - * - * **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information. - */ - ParticipantsByTypeAndID2: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * Return participant information error - * @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used. - */ - ParticipantsErrorByTypeAndID: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - Type: components["parameters"]["Type"]; - ID: components["parameters"]["ID"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * GetServicesByServiceType - * @description The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants - * that support a specified service. - */ - GetServicesByServiceType: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ServiceType: components["parameters"]["ServiceType"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutServicesByServiceType - * @description The HTTP request `PUT /services/{ServiceType}` is used to return list of participants - * that support a specified service. - */ - PutServicesByServiceType: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ServiceType: components["parameters"]["ServiceType"]; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["ServicesServiceTypePutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutServicesByServiceTypeAndError - * @description The HTTP request `PUT /services/{ServiceType}/error` is used to return error information - */ - PutServicesByServiceTypeAndError: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ServiceType: components["parameters"]["ServiceType"]; - }; - }; - /** @description Details of the error returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * ThirdpartyRequestsTransactionsPost - * @description The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP - */ - ThirdpartyRequestsTransactionsPost: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - /** @description Transaction request to be created. */ - requestBody: { - content: { - "application/json": components["schemas"]["ThirdpartyRequestsTransactionsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * GetThirdpartyTransactionRequests - * @description The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the - * retrieval of a third party transaction request. - */ - GetThirdpartyTransactionRequests: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * UpdateThirdPartyTransactionRequests - * @description The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about - * the status of a previously requested thirdparty transaction request. - * - * Switch(Thirdparty API Adapter) -> PISP - */ - UpdateThirdPartyTransactionRequests: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - /** - * @example { - * "transactionRequestState": "RECEIVED" - * } - */ - "application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPutResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * NotifyThirdpartyTransactionRequests - * @description The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to - * notify a thirdparty of the outcome of a transaction request. - * - * Switch(Thirdparty API Adapter) -> PISP - */ - NotifyThirdpartyTransactionRequests: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - requestBody: { - content: { - /** - * @example { - * "transactionRequestState": "ACCEPTED", - * "transactionState": "COMMITTED" - * } - */ - "application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * ThirdpartyTransactionRequestsError - * @description If the server is unable to find the transaction request, or another processing error occurs, - * the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used. - * The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of - * the thirdparty transaction request. - */ - ThirdpartyTransactionRequestsError: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Error information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PostThirdpartyRequestsAuthorizations - * @description The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request. - */ - PostThirdpartyRequestsAuthorizations: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - /** @description Authorization request details */ - requestBody: { - content: { - "application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsPostRequest"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * GetThirdpartyRequestsAuthorizationsById - * @description The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating - * to a previously issued authorization request. The *{ID}* in the request should match the - * `authorizationRequestId` which was given when the authorization request was created. - */ - GetThirdpartyRequestsAuthorizationsById: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutThirdpartyRequestsAuthorizationsById - * @description After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the - * transaction to their user, and request that the client sign the `challenge` field using the credential - * they previously registered. - * - * The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_: - */ - PutThirdpartyRequestsAuthorizationsById: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Signed authorization object */ - requestBody: { - content: { - "application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseRejected"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseFIDO"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseGeneric"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutThirdpartyRequestsAuthorizationsByIdAndError - * @description The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform - * the other party that something went wrong with a Thirdparty Transaction Authorization Request. - * - * The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't - * match a `transactionRequestId`. - * - * The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}` - * was invalid. - */ - PutThirdpartyRequestsAuthorizationsByIdAndError: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Error information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; - }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PostThirdpartyRequestsVerifications - * @description The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization. - */ - PostThirdpartyRequestsVerifications: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - }; - /** @description The thirdparty authorization details to verify */ - requestBody: { - content: { - "application/json": components["schemas"]["ThirdpartyRequestsVerificationsPostRequestFIDO"] | components["schemas"]["ThirdpartyRequestsVerificationsPostRequestGeneric"]; - }; - }; - responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * GetThirdpartyRequestsVerificationsById - * @description The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get - * information regarding a previously created or requested authorization. The *{ID}* - * in the URI should contain the verification request ID - */ - GetThirdpartyRequestsVerificationsById: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - Accept: components["parameters"]["Accept"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; + schemas: { + /** + * PartyIdType + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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). + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - 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. + * - CONSENT - A Consent represents an agreement between a PISP, a Customer and + * a DFSP which allows the PISP permission to perform actions on behalf of the + * customer. A Consent has an authoritative source: either the DFSP who issued + * the Consent, or an Auth Service which administers the Consent. + * - THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP, + * a DFSP, and a specific Customer's account at the DFSP. The content of the link + * is created by the DFSP at the time when it gives permission to the PISP for + * specific access to a given account. + * + * @example PERSONAL_ID + * @enum {string} + */ + PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK"; + /** + * PartyIdentifier + * @description Identifier of the Party. + * @example 16135551212 + */ + PartyIdentifier: string; + /** + * PartySubIdOrType + * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType. + */ + PartySubIdOrType: string; + /** + * FspId + * @description FSP identifier. + */ + FspId: string; + /** + * ExtensionKey + * @description Extension key. + */ + ExtensionKey: string; + /** + * ExtensionValue + * @description Extension value. + */ + ExtensionValue: string; + /** + * Extension + * @description Data model for the complex type Extension. + */ + Extension: { + key: components["schemas"]["ExtensionKey"]; + value: components["schemas"]["ExtensionValue"]; + }; + /** + * ExtensionList + * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment. + */ + ExtensionList: { + /** @description Number of Extension elements. */ + extension: components["schemas"]["Extension"][]; + }; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. + */ + PartyIdInfo: { + partyIdType: components["schemas"]["PartyIdType"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorCode + * @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error. + * @example 5100 + */ + ErrorCode: string; + /** + * ErrorDescription + * @description Error description string. + */ + ErrorDescription: string; + /** + * ErrorInformation + * @description Data model for the complex type ErrorInformation. + */ + ErrorInformation: { + errorCode: components["schemas"]["ErrorCode"]; + errorDescription: components["schemas"]["ErrorDescription"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * PartyResult + * @description Data model for the complex type PartyResult. + */ + PartyResult: { + partyId: components["schemas"]["PartyIdInfo"]; + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * Currency + * @description The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies. + * @enum {string} + */ + Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD"; + /** + * ParticipantsIDPutResponse + * @description The object sent in the PUT /participants/{ID} callback. + */ + ParticipantsIDPutResponse: { + /** @description List of PartyResult elements that were either created or failed to be created. */ + partyList: components["schemas"]["PartyResult"][]; + currency?: components["schemas"]["Currency"]; + }; + /** + * MerchantClassificationCode + * @description A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc. + */ + MerchantClassificationCode: string; + /** + * PartyName + * @description Name of the Party. Could be a real name or a nickname. + */ + PartyName: string; + /** + * FirstName + * @description First name of the Party (Name Type). + * @example Henrik + */ + FirstName: string; + /** + * MiddleName + * @description Middle name of the Party (Name Type). + * @example Johannes + */ + MiddleName: string; + /** + * LastName + * @description Last name of the Party (Name Type). + * @example Karlsson + */ + LastName: string; + /** + * PartyComplexName + * @description Data model for the complex type PartyComplexName. + */ + PartyComplexName: { + firstName?: components["schemas"]["FirstName"]; + middleName?: components["schemas"]["MiddleName"]; + lastName?: components["schemas"]["LastName"]; + }; + /** + * DateofBirth (type Date) + * @description Date of Birth of the Party. + * @example 1966-06-16 + */ + DateOfBirth: string; + /** + * PartyPersonalInfo + * @description Data model for the complex type PartyPersonalInfo. + */ + PartyPersonalInfo: { + complexName?: components["schemas"]["PartyComplexName"]; + dateOfBirth?: components["schemas"]["DateOfBirth"]; + }; + /** + * Party + * @description Data model for the complex type Party. + */ + Party: { + partyIdInfo: components["schemas"]["PartyIdInfo"]; + merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"]; + name?: components["schemas"]["PartyName"]; + personalInfo?: components["schemas"]["PartyPersonalInfo"]; + }; + /** + * PartiesTypeIDPutResponse + * @description The object sent in the PUT /parties/{Type}/{ID} callback. + * + * This is a variant based on FSPIOP `PartiesTypeIDPutResponse` specification. + * Main difference being that it returns a `Party` with the newly added + * `accounts` property. + * + */ + PartiesTypeIDPutResponse: { + party: components["schemas"]["Party"]; + }; + /** + * Amount + * @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed. + * @example 123.45 + */ + Amount: string; + /** + * Money + * @description Data model for the complex type Money. + */ + Money: { + currency: components["schemas"]["Currency"]; + amount: components["schemas"]["Amount"]; + }; + /** + * DateTime + * @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC). + * @example 2016-05-24T08:38:08.699-04:00 + */ + DateTime: string; + /** + * Latitude + * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +45.4215 + */ + Latitude: string; + /** + * Longitude + * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. + * @example +75.6972 + */ + Longitude: string; + /** + * GeoCode + * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated. + */ + GeoCode: { + latitude: components["schemas"]["Latitude"]; + longitude: components["schemas"]["Longitude"]; + }; + /** + * IlpPacket + * @description Information for recipient (transport layer information). + * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA + */ + IlpPacket: string; + /** + * IlpCondition + * @description Condition that must be attached to the transfer by the Payer. + */ + IlpCondition: string; + /** + * QuotesIDPutResponse + * @description The object sent in the PUT /quotes/{ID} callback. + */ + QuotesIDPutResponse: { + transferAmount: components["schemas"]["Money"]; + payeeReceiveAmount?: components["schemas"]["Money"]; + payeeFspFee?: components["schemas"]["Money"]; + payeeFspCommission?: components["schemas"]["Money"]; + expiration: components["schemas"]["DateTime"]; + geoCode?: components["schemas"]["GeoCode"]; + ilpPacket: components["schemas"]["IlpPacket"]; + condition: components["schemas"]["IlpCondition"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * TransactionRequestState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payer FSP has received the transaction from the Payee FSP. + * - PENDING - Payer FSP has sent the transaction request to the Payer. + * - ACCEPTED - Payer has approved the transaction. + * - REJECTED - Payer has rejected the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED"; + /** + * TransactionState + * @description Below are the allowed values for the enumeration. + * - RECEIVED - Payee FSP has received the transaction from the Payer FSP. + * - PENDING - Payee FSP has validated the transaction. + * - COMPLETED - Payee FSP has successfully performed the transaction. + * - REJECTED - Payee FSP has failed to perform the transaction. + * @example RECEIVED + * @enum {string} + */ + TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED"; + /** + * ThirdpartyRequestsTransactionsIDPatchResponse + * @description Used by: DFSP + * The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer. + * This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource. + * The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations + */ + ThirdpartyRequestsTransactionsIDPatchResponse: { + completedTimestamp?: components["schemas"]["DateTime"]; + transactionRequestState: components["schemas"]["TransactionRequestState"]; + transactionState: components["schemas"]["TransactionState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * AuthorizationResponseType + * @description Enum containing authorization response information; if the customer + * accepted the terms of the transfer, or rejected the terms. + * + * @enum {string} + */ + AuthorizationResponseType: "ACCEPTED" | "REJECTED"; + /** + * ConsentStatusIssued + * @description Allowed values for the enumeration ConsentStatus + * - ISSUED - The consent has been issued by the DFSP + * @enum {string} + */ + ConsentStatusIssued: "ISSUED"; + /** + * IlpFulfilment + * @description Fulfilment that must be attached to the transfer by the Payee. + * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8 + */ + IlpFulfilment: string; + /** + * Integer + * @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits. + */ + Integer: string; + /** + * Note + * @description Memo assigned to transaction. + * @example Note sent to Payee. + */ + Note: string; + /** + * PartyIdTypeTPLink + * @description - THIRD_PARTY_LINK - is the DFSP's internal reference which allows DFSP to find out the corresponding consent + * + * @example PERSONAL_ID + * @enum {string} + */ + PartyIdTypeTPLink: "THIRD_PARTY_LINK"; + /** + * PartyIdInfo + * @description Data model for the complex type PartyIdInfo. + */ + PartyIdInfoTPLink: { + partyIdType: components["schemas"]["PartyIdTypeTPLink"]; + partyIdentifier: components["schemas"]["PartyIdentifier"]; + partySubIdOrType?: components["schemas"]["PartySubIdOrType"]; + fspId?: components["schemas"]["FspId"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ServiceType + * @description The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource. + * Below are the allowed values for the enumeration ServiceType - THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE - Participants which provide Authentication Services. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype + * @enum {string} + */ + ServiceType: "THIRD_PARTY_DFSP" | "PISP" | "AUTH_SERVICE"; + /** + * CorrelationId + * @description Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘). + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + CorrelationId: string; + /** + * ParticipantsPostRequest + * @description The object sent in the POST /participants request. + */ + ParticipantsPostRequest: { + requestId: components["schemas"]["CorrelationId"]; + /** @description List of PartyIdInfo elements that the client would like to update + * or create FSP information about. + * */ + partyList: components["schemas"]["PartyIdInfo"][]; + currency?: components["schemas"]["Currency"]; + }; + /** + * AmountType + * @description Below are the allowed values for the enumeration AmountType. + * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. + * - 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. + * @example RECEIVE + * @enum {string} + */ + AmountType: "SEND" | "RECEIVE"; + /** + * TransactionScenario + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction. + * - 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. + * - REFUND - Used for performing a refund of transaction. + * @example DEPOSIT + * @enum {string} + */ + TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND"; + /** + * TransactionSubScenario + * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). + * @example LOCALLY_DEFINED_SUBSCENARIO + */ + TransactionSubScenario: string; + /** + * TransactionInitiator + * @description Below are the allowed values for the enumeration. + * - 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. + * - 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. + * @example PAYEE + * @enum {string} + */ + TransactionInitiator: "PAYER" | "PAYEE"; + /** + * TransactionInitiatorType + * @description Below are the allowed values for the enumeration. + * - CONSUMER - Consumer is the initiator of the transaction. + * - AGENT - Agent is the initiator of the transaction. + * - BUSINESS - Business is the initiator of the transaction. + * - DEVICE - Device is the initiator of the transaction. + * @example CONSUMER + * @enum {string} + */ + TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE"; + /** + * RefundReason + * @description Reason for the refund. + * @example Free text indicating reason for the refund. + */ + RefundReason: string; + /** + * Refund + * @description Data model for the complex type Refund. + */ + Refund: { + originalTransactionId: components["schemas"]["CorrelationId"]; + refundReason?: components["schemas"]["RefundReason"]; + }; + /** + * BalanceOfPayments + * @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. + * @example 123 + */ + BalanceOfPayments: string; + /** + * TransactionType + * @description Data model for the complex type TransactionType. + */ + TransactionType: { + scenario: components["schemas"]["TransactionScenario"]; + subScenario?: components["schemas"]["TransactionSubScenario"]; + initiator: components["schemas"]["TransactionInitiator"]; + initiatorType: components["schemas"]["TransactionInitiatorType"]; + refundInfo?: components["schemas"]["Refund"]; + balanceOfPayments?: components["schemas"]["BalanceOfPayments"]; + }; + /** + * QuotesPostRequest + * @description The object sent in the POST /quotes request. + */ + QuotesPostRequest: { + /** + * @description Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. + * @example b51ec534-ee48-4575-b6a9-ead2955b8069 + */ + quoteId: components["schemas"]["CorrelationId"]; + /** + * @description Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction. + * @example a8323bc6-c228-4df2-ae82-e5a997baf899 + */ + transactionId: components["schemas"]["CorrelationId"]; + /** + * @description Identifies an optional previously-sent transaction request. + * @example a8323bc6-c228-4df2-ae82-e5a997baf890 + */ + transactionRequestId?: components["schemas"]["CorrelationId"]; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + /** @description Information about the Payer in the proposed financial transaction. */ + payer: components["schemas"]["Party"]; + /** + * @description SEND for send amount, RECEIVE for receive amount. + * @example SEND + */ + amountType: components["schemas"]["AmountType"]; + /** @description Depending on amountType - If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction. If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive any fees. The amount is not updated by any of the participating entities. */ + amount: components["schemas"]["Money"]; + /** @description The fees in the transaction. The fees element should be empty if fees should be non-disclosed. The fees element should be non-empty if fees should be disclosed. */ + fees?: components["schemas"]["Money"]; + /** @description Type of transaction for which the quote is requested. */ + transactionType: components["schemas"]["TransactionType"]; + /** @description Longitude and Latitude of the initiating Party. Can be used to detect fraud. */ + geoCode?: components["schemas"]["GeoCode"]; + /** + * @description A memo that will be attached to the transaction. + * @example Free-text memo. + */ + note?: components["schemas"]["Note"]; + /** + * @description Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit. + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration?: components["schemas"]["DateTime"]; + /** @description Optional extension, specific to deployment. */ + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorInformationResponse + * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses. + */ + ErrorInformationResponse: { + errorInformation?: components["schemas"]["ErrorInformation"]; + }; + /** + * Name + * @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. + * + * 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 ( ). + * + * **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. + */ + Name: string; + /** + * AccountAddress + * @description The AccountAddress data type is a variable length string with a maximum size of 1023 characters and consists of: + * Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.) + * - Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character + * An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain. + * IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case). + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress + */ + AccountAddress: string; + /** + * Account + * @description Data model for the complex type Account. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account + */ + Account: { + accountNickname: components["schemas"]["Name"]; + address: components["schemas"]["AccountAddress"]; + currency: components["schemas"]["Currency"]; + }; + /** + * AccountList + * @description The AccountList data model is used to hold information about the accounts that a party controls. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist + */ + AccountList: components["schemas"]["Account"][]; + /** + * AccountsIDPutResponse + * @description Callback and data model information for GET /accounts/{ID}: + * Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body + * The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid + */ + AccountsIDPutResponse: { + accounts: components["schemas"]["AccountList"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ErrorInformationObject + * @description Data model for the complex type object that contains ErrorInformation. + */ + ErrorInformationObject: { + errorInformation: components["schemas"]["ErrorInformation"]; + }; + /** + * ScopeAction + * @description The ScopeAction element contains an access type which a PISP can request + * from a DFSP, or which a DFSP can grant to a PISP. + * It must be a member of the appropriate enumeration. + * + * - ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account + * - ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP + * - ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account + * + * @enum {string} + */ + ScopeAction: "ACCOUNTS_GET_BALANCE" | "ACCOUNTS_TRANSFER" | "ACCOUNTS_STATEMENT"; + /** + * Scope + * @description The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope + */ + Scope: { + address: components["schemas"]["AccountAddress"]; + actions: components["schemas"]["ScopeAction"][]; + }; + /** + * ConsentRequestChannelType + * @description The auth channel being used for the consent request. + * - WEB - DFSP can support authorization via a web-based login. + * - OTP - DFSP can support authorization via a One Time PIN. + * + * @enum {string} + */ + ConsentRequestChannelType: "WEB" | "OTP"; + /** + * Uri + * @description The API data type Uri is a JSON string in a canonical format that is restricted by a regular expression for interoperability reasons. + * + */ + Uri: string; + /** + * ConsentRequestsPostRequest + * @description Used by: PISP + * The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request. + * Callback and data model for POST /consentRequests: + * Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests + */ + ConsentRequestsPostRequest: { + consentRequestId: components["schemas"]["CorrelationId"]; + /** @description The identifier used in the **GET /accounts/**_{ID}_. Used by the DFSP to correlate an account lookup to a `consentRequest` */ + userId: string; + scopes: components["schemas"]["Scope"][]; + authChannels: components["schemas"]["ConsentRequestChannelType"][]; + callbackUri: components["schemas"]["Uri"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ConsentRequestChannelTypeWeb + * @description The web auth channel being used for `PUT /consentRequest/{ID}` request. + * + * @enum {string} + */ + ConsentRequestChannelTypeWeb: "WEB"; + /** + * ConsentRequestsIDPutResponseWeb + * @description The object sent in a `PUT /consentRequests/{ID}` request. + * + * Schema used in the request consent phase of the account linking web flow, + * the result is the PISP being instructed on a specific URL where this + * supposed user should be redirected. This URL should be a place where + * the user can prove their identity (e.g., by logging in). + * + */ + ConsentRequestsIDPutResponseWeb: { + scopes: components["schemas"]["Scope"][]; + authChannels: components["schemas"]["ConsentRequestChannelTypeWeb"][]; + callbackUri: components["schemas"]["Uri"]; + authUri: components["schemas"]["Uri"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ConsentRequestChannelTypeOTP + * @description The OTP auth channel being used for `PUT /consentRequests/{ID}` request. + * + * @enum {string} + */ + ConsentRequestChannelTypeOTP: "OTP"; + /** + * ConsentRequestsIDPutResponseOTP + * @description The object sent in a `PUT /consentRequests/{ID}` request. + * + * Schema used in the request consent phase of the account linking OTP/SMS flow. + * + */ + ConsentRequestsIDPutResponseOTP: { + scopes: components["schemas"]["Scope"][]; + authChannels: components["schemas"]["ConsentRequestChannelTypeOTP"][]; + callbackUri?: components["schemas"]["Uri"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */ + BinaryString: string; + /** + * ConsentRequestsIDPatchRequest + * @description Used by: PISP + * After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid + */ + ConsentRequestsIDPatchRequest: { + authToken: components["schemas"]["BinaryString"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * CredentialType + * @description The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype + * @enum {string} + */ + CredentialType: "FIDO" | "GENERIC"; + /** + * CredentialStatusPending + * @description The status of the Credential. + * - "PENDING" - The credential has been created, but has not been verified + * + * @enum {string} + */ + CredentialStatusPending: "PENDING"; + /** + * GenericCredential + * @description A publicKey + signature of a challenge for a generic public/private keypair. + * + */ + GenericCredential: { + publicKey: components["schemas"]["BinaryString"]; + signature: components["schemas"]["BinaryString"]; + }; + /** + * FIDOPublicKeyCredentialAttestation + * @description A data model representing a FIDO Attestation result. Derived from + * [`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential). + * + * The `PublicKeyCredential` interface represents the below fields with + * a Type of Javascript [ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer). + * For this API, we represent ArrayBuffers as base64 encoded utf-8 strings. + * + */ + FIDOPublicKeyCredentialAttestation: { + /** @description credential id: identifier of pair of keys, base64 encoded + * https://w3c.github.io/webauthn/#ref-for-dom-credential-id + * */ + id: string; + /** @description raw credential id: identifier of pair of keys, base64 encoded + * */ + rawId?: string; + /** @description AuthenticatorAttestationResponse + * */ + response: { + /** @description JSON string with client data + * */ + clientDataJSON: string; + /** @description CBOR.encoded attestation object + * */ + attestationObject: string; + }; + /** + * @description response type, we need only the type of public-key + * @enum {string} + */ + type: "public-key"; + }; + /** + * SignedCredential + * @description A credential used to allow a user to prove their identity and access + * to an account with a DFSP. + * + * SignedCredential is a special formatting of the credential to allow us to be + * more explicit about the `status` field - it should only ever be PENDING when + * updating a credential. + * + */ + SignedCredential: { + credentialType: components["schemas"]["CredentialType"]; + status: components["schemas"]["CredentialStatusPending"]; + genericPayload?: components["schemas"]["GenericCredential"]; + fidoPayload?: components["schemas"]["FIDOPublicKeyCredentialAttestation"]; + }; + /** + * ConsentStatus + * @description Allowed values for the enumeration ConsentStatus + * - ISSUED - The consent has been issued by the DFSP + * - REVOKED - The consent has been revoked + * @enum {string} + */ + ConsentStatus: "ISSUED" | "REVOKED"; + /** + * ConsentPostRequestAUTH + * @description The object sent in a `POST /consents` request to the Auth-Service + * by a DFSP to store registered Consent and credential + * + */ + ConsentsPostRequestAUTH: { + /** @description Common ID between the PISP and FSP for the Consent object + * determined by the DFSP who creates the Consent. + * */ + consentId: components["schemas"]["CorrelationId"]; + consentRequestId?: components["schemas"]["CorrelationId"]; + scopes: components["schemas"]["Scope"][]; + credential: components["schemas"]["SignedCredential"]; + status: components["schemas"]["ConsentStatus"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ConsentPostRequestPISP + * @description The provisional Consent object sent by the DFSP in `POST /consents`. + * + */ + ConsentsPostRequestPISP: { + /** @description Common ID between the PISP and the Payer DFSP for the consent object. The ID + * should be reused for re-sends of the same consent. A new ID should be generated + * for each new consent. + * */ + consentId: components["schemas"]["CorrelationId"]; + /** @description The ID given to the original consent request on which this consent is based. + * */ + consentRequestId: components["schemas"]["CorrelationId"]; + scopes: components["schemas"]["Scope"][]; + status: components["schemas"]["ConsentStatus"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ConsentsIDPutResponseSigned + * @description The HTTP request `PUT /consents/{ID}` is used by the PISP to update a Consent with a signed challenge and register a credential. + * Called by a `PISP` to after signing a challenge. Sent to a DFSP for verification. + * + */ + ConsentsIDPutResponseSigned: { + status?: components["schemas"]["ConsentStatusIssued"]; + scopes: components["schemas"]["Scope"][]; + credential: components["schemas"]["SignedCredential"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * CredentialStatusVerified + * @description The status of the Credential. + * - "VERIFIED" - The Credential is valid and verified. + * + * @enum {string} + */ + CredentialStatusVerified: "VERIFIED"; + /** + * VerifiedCredential + * @description A credential used to allow a user to prove their identity and access + * to an account with a DFSP. + * + * VerifiedCredential is a special formatting of Credential to allow us to be + * more explicit about the `status` field - it should only ever be VERIFIED when + * updating a credential. + * + */ + VerifiedCredential: { + credentialType: components["schemas"]["CredentialType"]; + status: components["schemas"]["CredentialStatusVerified"]; + genericPayload?: components["schemas"]["GenericCredential"]; + fidoPayload?: components["schemas"]["FIDOPublicKeyCredentialAttestation"]; + }; + /** + * ConsentsIDPutResponseVerified + * @description The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified. + * Called by a `auth-service` to notify a DFSP that a credential has been verified and registered. + * + */ + ConsentsIDPutResponseVerified: { + status?: components["schemas"]["ConsentStatusIssued"]; + scopes: components["schemas"]["Scope"][]; + credential: components["schemas"]["VerifiedCredential"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ConsentsIDPatchResponseVerified + * @description PATCH /consents/{ID} request object. + * + * Sent by the DFSP to the PISP when a consent is issued and verified. + * Used in the "Register Credential" part of the Account linking flow. + * + */ + ConsentsIDPatchResponseVerified: { + credential: { + status: components["schemas"]["CredentialStatusVerified"]; + }; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ConsentStatusRevoked + * @description Allowed values for the enumeration ConsentStatus + * - REVOKED - The consent has been revoked + * @enum {string} + */ + ConsentStatusRevoked: "REVOKED"; + /** + * ConsentsIDPatchResponseRevoked + * @description PATCH /consents/{ID} request object. + * + * Sent to both the PISP and DFSP when a consent is revoked. + * Used in the "Unlinking" part of the Account Unlinking flow. + * + */ + ConsentsIDPatchResponseRevoked: { + status: components["schemas"]["ConsentStatusRevoked"]; + revokedAt: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ParticipantsTypeIDPutResponse + * @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks. + */ + ParticipantsTypeIDPutResponse: { + fspId?: components["schemas"]["FspId"]; + }; + /** + * ParticipantsTypeIDSubIDPostRequest + * @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes. + */ + ParticipantsTypeIDSubIDPostRequest: { + fspId: components["schemas"]["FspId"]; + currency?: components["schemas"]["Currency"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ServicesServiceTypePutResponse + * @description Used by: Switch + * The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup. + * Callback and data model information for GET /services/{ServiceType}: + * Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype + */ + ServicesServiceTypePutResponse: { + providers: components["schemas"]["FspId"][]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ThirdpartyRequestsTransactionsPostRequest + * @description Used by: PISP + * The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request. + * Callback and data model information for POST /thirdpartyRequests/transactions: + * Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions + */ + ThirdpartyRequestsTransactionsPostRequest: { + /** @description Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request. + * */ + transactionRequestId: components["schemas"]["CorrelationId"]; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + /** @description Information about the Payer in the proposed financial transaction. */ + payer: components["schemas"]["PartyIdInfo"]; + /** @description SEND for sendAmount, RECEIVE for receiveAmount. */ + amountType: components["schemas"]["AmountType"]; + /** @description Requested amount to be transferred from the Payer to Payee. */ + amount: components["schemas"]["Money"]; + /** @description Type of transaction. */ + transactionType: components["schemas"]["TransactionType"]; + /** @description A memo that will be attached to the transaction. */ + note?: string; + /** + * @description Date and time until when the transaction request is valid. It can be set to get a quick failure in case the peer FSP takes too long to respond. + * + * @example 2016-05-24T08:38:08.699-04:00 + */ + expiration: string; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ThirdpartyRequestsTransactionsIDPutResponse + * @description Used by: DFSP + * After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid + */ + ThirdpartyRequestsTransactionsIDPutResponse: { + transactionId?: components["schemas"]["CorrelationId"]; + transactionRequestState: components["schemas"]["TransactionRequestState"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ThirdpartyRequestsAuthorizationsPostRequest + * @description Used by: DFSP + * The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request. + * Callback and data model information for POST /thirdpartyRequests/authorizations: + * Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations + */ + ThirdpartyRequestsAuthorizationsPostRequest: { + authorizationRequestId: components["schemas"]["CorrelationId"]; + transactionRequestId: components["schemas"]["CorrelationId"]; + /** @description The challenge that the PISP's client is to sign */ + challenge: string; + /** @description The amount that will be debited from the sending customer's account as a consequence of the transaction. */ + transferAmount: components["schemas"]["Money"]; + /** @description The amount that will be credited to the receiving customer's account as a consequence of the transaction. */ + payeeReceiveAmount: components["schemas"]["Money"]; + /** @description The amount of fees that the paying customer will be charged as part of the transaction. */ + fees: components["schemas"]["Money"]; + /** @description Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction. */ + payer: components["schemas"]["PartyIdInfo"]; + /** @description Information about the Payee in the proposed financial transaction. */ + payee: components["schemas"]["Party"]; + transactionType: components["schemas"]["TransactionType"]; + /** @description The time by which the transfer must be completed, set by the payee DFSP. */ + expiration: components["schemas"]["DateTime"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * AuthorizationResponseTypeRejected + * @description The customer rejected the terms of the transfer. + * + * @enum {string} + */ + AuthorizationResponseTypeRejected: "REJECTED"; + /** + * ThirdpartyRequestsAuthorizationsIDPutResponseRejected + * @description The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback. + */ + ThirdpartyRequestsAuthorizationsIDPutResponseRejected: { + responseType: components["schemas"]["AuthorizationResponseTypeRejected"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * AuthorizationResponseType + * @description The customer accepted the terms of the transfer + * + * @enum {string} + */ + AuthorizationResponseTypeAccepted: "ACCEPTED"; + /** + * SignedPayloadTypeFIDO + * @description Describes a challenge that has been signed with FIDO Attestation flows + * @enum {string} + */ + SignedPayloadTypeFIDO: "FIDO"; + /** + * FIDOPublicKeyCredentialAssertion + * @description A data model representing a FIDO Assertion result. + * Derived from PublicKeyCredential Interface in WebAuthN. + * + * The PublicKeyCredential interface represents the below fields with a Type of + * Javascript ArrayBuffer. + * For this API, we represent ArrayBuffers as base64 encoded utf-8 strings. + * + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion + * + */ + FIDOPublicKeyCredentialAssertion: { + /** @description credential id: identifier of pair of keys, base64 encoded + * https://w3c.github.io/webauthn/#ref-for-dom-credential-id + * */ + id: string; + /** @description raw credential id: identifier of pair of keys, base64 encoded. + * */ + rawId: string; + /** @description AuthenticatorAssertionResponse + * */ + response: { + /** @description Authenticator data object. + * */ + authenticatorData: string; + /** @description JSON string with client data. + * */ + clientDataJSON: string; + /** @description The signature generated by the private key associated with this credential. + * */ + signature: string; + /** @description This field is optionally provided by the authenticator, and + * represents the user.id that was supplied during registration. + * */ + userHandle?: string; + }; + /** + * @description response type, we need only the type of public-key + * @enum {string} + */ + type: "public-key"; + }; + /** SignedPayloadFIDO */ + SignedPayloadFIDO: { + signedPayloadType: components["schemas"]["SignedPayloadTypeFIDO"]; + fidoSignedPayload: components["schemas"]["FIDOPublicKeyCredentialAssertion"]; + }; + /** + * ThirdpartyRequestsAuthorizationsIDPutResponseFIDO + * @description The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback. + */ + ThirdpartyRequestsAuthorizationsIDPutResponseFIDO: { + responseType: components["schemas"]["AuthorizationResponseTypeAccepted"]; + signedPayload: components["schemas"]["SignedPayloadFIDO"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * SignedPayloadTypeGeneric + * @description Describes a challenge that has been signed with a private key + * @enum {string} + */ + SignedPayloadTypeGeneric: "GENERIC"; + /** SignedPayloadGeneric */ + SignedPayloadGeneric: { + signedPayloadType: components["schemas"]["SignedPayloadTypeGeneric"]; + genericSignedPayload: components["schemas"]["BinaryString"]; + }; + /** + * ThirdpartyRequestsAuthorizationsIDPutResponseGeneric + * @description The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback. + */ + ThirdpartyRequestsAuthorizationsIDPutResponseGeneric: { + responseType: components["schemas"]["AuthorizationResponseTypeAccepted"]; + signedPayload: components["schemas"]["SignedPayloadGeneric"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ThirdpartyRequestsVerificationsPostRequestFIDO + * @description The object sent in the POST /thirdpartyRequests/verifications request. + */ + ThirdpartyRequestsVerificationsPostRequestFIDO: { + verificationRequestId: components["schemas"]["CorrelationId"]; + /** @description Base64 encoded bytes - The challenge generated by the DFSP. */ + challenge: string; + /** @description The id of the stored consent object that contains the credential with which to verify + * the signed challenge against. + * */ + consentId: components["schemas"]["CorrelationId"]; + signedPayloadType: components["schemas"]["SignedPayloadTypeFIDO"]; + fidoSignedPayload: components["schemas"]["FIDOPublicKeyCredentialAssertion"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * ThirdpartyRequestsVerificationsPostRequestGeneric + * @description The object sent in the POST /thirdpartyRequests/verifications request. + */ + ThirdpartyRequestsVerificationsPostRequestGeneric: { + verificationRequestId: components["schemas"]["CorrelationId"]; + /** @description Base64 encoded bytes - The challenge generated by the DFSP. */ + challenge: string; + /** @description The id of the stored consent object that contains the credential with which to verify + * the signed challenge against. + * */ + consentId: components["schemas"]["CorrelationId"]; + signedPayloadType: components["schemas"]["SignedPayloadTypeGeneric"]; + genericSignedPayload: components["schemas"]["BinaryString"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; + /** + * AuthenticationResponse + * @description The AuthenticationResponse enumeration describes the result of authenticating verification request. + * Below are the allowed values for the enumeration AuthenticationResponse. - VERIFIED - The challenge was correctly signed. + * @enum {string} + */ + AuthenticationResponse: "VERIFIED"; + /** + * ThirdpartyRequestsVerificationsIDPutResponse + * @description Used by: Auth Service + * The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}. + * https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid + */ + ThirdpartyRequestsVerificationsIDPutResponse: { + authenticationResponse: components["schemas"]["AuthenticationResponse"]; + extensionList?: components["schemas"]["ExtensionList"]; + }; }; responses: { - 202: components["responses"]["202"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutThirdpartyRequestsVerificationsById - * @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request. - * If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`. - * In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`. - */ - PutThirdpartyRequestsVerificationsById: { - parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description The result of validating the Thirdparty Transaction Request */ - requestBody: { - content: { - /** - * @example { - * "authenticationResponse": "VERIFIED" - * } - */ - "application/json": components["schemas"]["ThirdpartyRequestsVerificationsIDPutResponse"]; - }; + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Accepted */ + 202: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Bad Request */ + 400: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Unauthorized */ + 401: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Forbidden */ + 403: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Found */ + 404: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Method Not Allowed */ + 405: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Acceptable */ + 406: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Not Implemented */ + 501: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; + /** @description Service Unavailable */ + 503: { + headers: { + "Content-Length": components["headers"]["Content-Length"]; + "Content-Type": components["headers"]["Content-Type"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ErrorInformationResponse"]; + }; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; - /** - * PutThirdpartyRequestsVerificationsByIdAndError - * @description The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform - * the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request. - */ - PutThirdpartyRequestsVerificationsByIdAndError: { parameters: { - header: { - "Content-Type": components["parameters"]["Content-Type"]; - Date: components["parameters"]["Date"]; - "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; - "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; - "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; - "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; - "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; - "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; - "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; - "Content-Length"?: components["parameters"]["Content-Length"]; - }; - path: { - ID: components["parameters"]["ID"]; - }; - }; - /** @description Error information returned. */ - requestBody: { - content: { - "application/json": components["schemas"]["ErrorInformationObject"]; - }; + /** @description The identifier value. */ + ID: string; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: string; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For": string; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": string; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination": string; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption": string; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature": string; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI": string; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method": string; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: string; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: string; + /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ + ServiceType: string; + }; + requestBodies: never; + headers: { + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length": number; + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": string; + }; + pathItems: never; +} +export type $defs = Record; +export interface operations { + test: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["ParticipantsIDPutResponse"] | components["schemas"]["PartiesTypeIDPutResponse"] | components["schemas"]["QuotesIDPutResponse"] | components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"] | components["schemas"]["AuthorizationResponseType"] | components["schemas"]["ConsentStatusIssued"] | components["schemas"]["IlpFulfilment"] | components["schemas"]["Integer"] | components["schemas"]["Note"] | components["schemas"]["PartyIdInfoTPLink"] | components["schemas"]["PartyResult"] | components["schemas"]["ServiceType"] | components["schemas"]["ParticipantsPostRequest"] | components["schemas"]["QuotesPostRequest"]; + }; + }; + responses: { + /** @description Ok */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + GetAccountsByUserId: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + UpdateAccountsByUserId: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + /** @example [ + * { + * "accountNickname": "dfspa.user.nickname1", + * "id": "dfspa.username.1234", + * "currency": "ZAR" + * }, + * { + * "accountNickname": "dfspa.user.nickname2", + * "id": "dfspa.username.5678", + * "currency": "USD" + * } + * ] */ + "application/json": components["schemas"]["AccountsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + UpdateAccountsByUserIdError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + HealthGet: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + MetricsGet: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + CreateConsentRequest: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + /** @description The consentRequest to create */ + requestBody: { + content: { + "application/json": components["schemas"]["ConsentRequestsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + GetConsentRequestsById: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + UpdateConsentRequest: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ConsentRequestsIDPutResponseWeb"] | components["schemas"]["ConsentRequestsIDPutResponseOTP"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PatchConsentRequest: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ConsentRequestsIDPatchRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + NotifyErrorConsentRequests: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Error information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PostConsents: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ConsentsPostRequestAUTH"] | components["schemas"]["ConsentsPostRequestPISP"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + GetConsent: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutConsentByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ConsentsIDPutResponseSigned"] | components["schemas"]["ConsentsIDPutResponseVerified"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + DeleteConsentByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PatchConsentByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ConsentsIDPatchResponseVerified"] | components["schemas"]["ConsentsIDPatchResponseRevoked"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + NotifyErrorConsents: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Error information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + Participants1: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutParticipantsByID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutParticipantsByIDAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID3: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByIDAndType: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Participant information to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsByTypeAndID2: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ParticipantsErrorByTypeAndID: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */ + Type: components["parameters"]["Type"]; + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + GetServicesByServiceType: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ + ServiceType: components["parameters"]["ServiceType"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutServicesByServiceType: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ + ServiceType: components["parameters"]["ServiceType"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["ServicesServiceTypePutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutServicesByServiceTypeAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The type of the service identifier. For example, `THIRD_PARTY_DFSP` */ + ServiceType: components["parameters"]["ServiceType"]; + }; + cookie?: never; + }; + /** @description Details of the error returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ThirdpartyRequestsTransactionsPost: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + /** @description Transaction request to be created. */ + requestBody: { + content: { + "application/json": components["schemas"]["ThirdpartyRequestsTransactionsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + GetThirdpartyTransactionRequests: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + UpdateThirdPartyTransactionRequests: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + /** @example { + * "transactionRequestState": "RECEIVED" + * } */ + "application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + NotifyThirdpartyTransactionRequests: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody: { + content: { + /** @example { + * "transactionRequestState": "ACCEPTED", + * "transactionState": "COMMITTED" + * } */ + "application/json": components["schemas"]["ThirdpartyRequestsTransactionsIDPatchResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + ThirdpartyTransactionRequestsError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Error information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PostThirdpartyRequestsAuthorizations: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + /** @description Authorization request details */ + requestBody: { + content: { + "application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsPostRequest"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + GetThirdpartyRequestsAuthorizationsById: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutThirdpartyRequestsAuthorizationsById: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Signed authorization object */ + requestBody: { + content: { + "application/json": components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseRejected"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseFIDO"] | components["schemas"]["ThirdpartyRequestsAuthorizationsIDPutResponseGeneric"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutThirdpartyRequestsAuthorizationsByIdAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Error information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PostThirdpartyRequestsVerifications: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path?: never; + cookie?: never; + }; + /** @description The thirdparty authorization details to verify */ + requestBody: { + content: { + "application/json": components["schemas"]["ThirdpartyRequestsVerificationsPostRequestFIDO"] | components["schemas"]["ThirdpartyRequestsVerificationsPostRequestGeneric"]; + }; + }; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + GetThirdpartyRequestsVerificationsById: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */ + Accept: components["parameters"]["Accept"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["202"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutThirdpartyRequestsVerificationsById: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description The result of validating the Thirdparty Transaction Request */ + requestBody: { + content: { + /** @example { + * "authenticationResponse": "VERIFIED" + * } */ + "application/json": components["schemas"]["ThirdpartyRequestsVerificationsIDPutResponse"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; + }; + PutThirdpartyRequestsVerificationsByIdAndError: { + parameters: { + query?: never; + header: { + /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */ + "Content-Type": components["parameters"]["Content-Type"]; + /** @description The `Date` header field indicates the date when the request was sent. */ + Date: components["parameters"]["Date"]; + /** @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API. + * + * **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`. */ + "X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"]; + /** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */ + "FSPIOP-Source": components["parameters"]["FSPIOP-Source"]; + /** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */ + "FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"]; + /** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */ + "FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"]; + /** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */ + "FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"]; + /** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"]; + /** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */ + "FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"]; + /** @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body. + * + * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes). */ + "Content-Length"?: components["parameters"]["Content-Length"]; + }; + path: { + /** @description The identifier value. */ + ID: components["parameters"]["ID"]; + }; + cookie?: never; + }; + /** @description Error information returned. */ + requestBody: { + content: { + "application/json": components["schemas"]["ErrorInformationObject"]; + }; + }; + responses: { + 200: components["responses"]["200"]; + 400: components["responses"]["400"]; + 401: components["responses"]["401"]; + 403: components["responses"]["403"]; + 404: components["responses"]["404"]; + 405: components["responses"]["405"]; + 406: components["responses"]["406"]; + 501: components["responses"]["501"]; + 503: components["responses"]["503"]; + }; }; - responses: { - 200: components["responses"]["200"]; - 400: components["responses"]["400"]; - 401: components["responses"]["401"]; - 403: components["responses"]["403"]; - 404: components["responses"]["404"]; - 405: components["responses"]["405"]; - 406: components["responses"]["406"]; - 501: components["responses"]["501"]; - 503: components["responses"]["503"]; - }; - }; }