@mojaloop/api-snippets 17.6.0-snapshot.0 → 17.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/audit-ci.jsonc +2 -1
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +1 -1
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +1 -1
- package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +4735 -0
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +1 -1
- package/docs/index.html +1 -0
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +7 -7
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
- package/docs/thirdparty-openapi3-snippets.yaml +1 -1
- package/fspiop/v1_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -1
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountIdentification4Choice.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AccountSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyAndAmount_SimpleType.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ActiveOrHistoricCurrencyCode.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType2Code.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AddressType3Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/AnyBICDec2014Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BICFIDec2014Identifier.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BaseOneRate.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification6.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchAndFinancialInstitutionIdentification8.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData3.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/BranchData5.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccount40.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CashAccountType2Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CategoryPurpose1Choice.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeBearerType1Code.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ChargeType3Choice.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Charges16.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingChannel2Code.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemIdentification2Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ClearingSystemMemberIdentification2.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact13.yaml +39 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Contact4.yaml +36 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CountryCode.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction67.yaml +125 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CreditTransferTransaction68.yaml +69 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/CryptographicLockChoice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DateAndPlaceOfBirth1.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/DatePeriod2.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorCode.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorDescription.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformation.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact32HexBinaryText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Exact4AlphaNumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Execute_FIToFICustomerCreditTransferV13.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Extension.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionKey.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionList.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExtensionValue.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalAccountIdentification1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCashAccountType1Code.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCategoryPurpose1Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalChargeType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalClearingSystemIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalCreditorAgentInstruction1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalFinancialInstitutionIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalLocalInstrument1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalOrganisationIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPaymentTransactionStatus1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPersonIdentification1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalProxyAccountType1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalPurpose1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalServiceLevel1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalStatusReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ExternalVerificationReason1Code.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialIdentificationSchemeName1Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxRequest_FICreditTransferProposal.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FxResponse_FICreditTransferConfirmation.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericAccountIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericFinancialIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification3.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericIdentification30.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericOrganisationIdentification3.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification1.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GenericPersonIdentification2.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetPartiesError_IdentificationVerificationReportV03.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GetParties_IdentificationVerificationReportV03.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader113.yaml +72 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader120.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/GroupHeader129.yaml +58 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IBAN2007Identifier.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODate.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISODateTime.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ISOYear.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationAssignment3.yaml +33 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationInformation4.yaml +22 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/IdentificationVerificationIndicator.yaml +3 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Instruction4Code.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForCreditorAgent3.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/InstructionForNextAgent1.yaml +13 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LEIIdentifier.yaml +8 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/LocalInstrument2Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max105Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max10Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max128Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max140Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max15NumericText.yaml +6 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max16Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max2048Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max256Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max34Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max350Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max35Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max4Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Max70Text.yaml +7 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/NamePrefix2Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Number.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification29.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentification39.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OrganisationIdentificationSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/OtherContact1.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsError_FIToFIPaymentStatusReportV15.yaml +35 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15.yaml +79 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party38Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party40Choice.yaml +37 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Party52Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification135.yaml +34 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PartyIdentification272.yaml +42 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentIdentification13.yaml +23 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTransaction163.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PaymentTypeInformation28.yaml +24 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PercentageRate.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification13.yaml +18 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentification18.yaml +18 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PersonIdentificationSchemeName1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PhoneNumber.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress24.yaml +55 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PostalAddress27.yaml +61 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod1Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/PreferredContactMethod2Code.yaml +11 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Priority2Code.yaml +9 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountIdentification1.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ProxyAccountType1Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/Purpose2Choice.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryAuthority2.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReporting3.yaml +19 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/RegulatoryReportingType1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/ServiceLevel8Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementInstruction15.yaml +40 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SettlementMethod1Code.yaml +10 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReason6Choice.yaml +16 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StatusReasonInformation14.yaml +27 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/StructuredRegulatoryReporting3.yaml +26 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryData1.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/SupplementaryDataEnvelope1.yaml +5 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAmount3.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxAuthorisation1.yaml +12 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxData1.yaml +57 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty1.yaml +15 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxParty2.yaml +20 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxPeriod3.yaml +17 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecord3.yaml +38 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordDetails3.yaml +21 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TaxRecordPeriod1Code.yaml +43 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsRequest_FIToFICustomerCreditProposal.yaml +25 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation.yaml +28 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/UUIDv4Identifier.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReason1Choice.yaml +14 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/VerificationReport4.yaml +29 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/hexBinary.yaml +4 -0
- package/fspiop/v2_0_ISO20022/openapi3/openapi.yaml +53 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}.yaml +81 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxQuotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers.yaml +47 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}.yaml +120 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/fxTransfers_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}.yaml +82 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_error.yaml +50 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}.yaml +83 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/parties_{Type}_{ID}_{SubId}_error.yaml +51 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}.yaml +80 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/quotes_{ID}_error.yaml +49 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers.yaml +46 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}.yaml +119 -0
- package/fspiop/v2_0_ISO20022/openapi3/paths/transfers_{ID}_error.yaml +49 -0
- package/lib/fspiop/v1_0/openapi.d.ts +1494 -409
- package/lib/fspiop/v1_1/openapi.d.ts +1495 -417
- package/lib/fspiop/v2_0/json-schemas.json +39 -39
- package/lib/fspiop/v2_0/openapi.d.ts +1945 -560
- package/lib/fspiop/v2_0_ISO20022/index.d.ts +3 -0
- package/lib/fspiop/v2_0_ISO20022/index.js +9 -0
- package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/json-schemas.json +107991 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.d.ts +5162 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js +7 -0
- package/lib/fspiop/v2_0_ISO20022/openapi.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +95738 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js +171 -0
- package/lib/fspiop/v2_0_ISO20022/schemas.js.map +1 -0
- package/lib/fspiop/v2_0_ISO20022/types.d.ts +164 -0
- package/lib/fspiop/v2_0_ISO20022/types.js +4 -0
- package/lib/fspiop/v2_0_ISO20022/types.js.map +1 -0
- package/lib/index.d.ts +3 -0
- package/lib/index.js +4 -1
- package/lib/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +384 -74
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +55 -55
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +543 -109
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +66 -66
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +503 -139
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +72 -72
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +694 -184
- package/lib/thirdparty/openapi.d.ts +1639 -612
- package/package.json +30 -27
- package/sdk-bulk.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_0_0/components/schemas/CorrelationId.yaml +1 -1
- package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +6 -6
- package/sdk-scheme-adapter/v2_1_0/components/schemas/CorrelationId.yaml +1 -1
@@ -0,0 +1,4735 @@
|
|
1
|
+
openapi: 3.0.2
|
2
|
+
info:
|
3
|
+
version: v2.0-iso20022-draft
|
4
|
+
title: Open API for FSP Interoperability (FSPIOP) - the ISO 20022 message version
|
5
|
+
description: IN PROGRESS
|
6
|
+
license:
|
7
|
+
name: CC BY-ND 4.0
|
8
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
9
|
+
contact:
|
10
|
+
name: Sam Kummary
|
11
|
+
url: https://github.com/mojaloop/mojaloop-specification/issues
|
12
|
+
servers:
|
13
|
+
- url: protocol://hostname:<port>/switch/
|
14
|
+
variables:
|
15
|
+
protocol:
|
16
|
+
enum:
|
17
|
+
- http
|
18
|
+
- https
|
19
|
+
default: https
|
20
|
+
paths:
|
21
|
+
/parties/{Type}/{ID}:
|
22
|
+
parameters:
|
23
|
+
- $ref: "#/components/parameters/Type"
|
24
|
+
- $ref: "#/components/parameters/ID"
|
25
|
+
- $ref: "#/components/parameters/Content-Type"
|
26
|
+
- $ref: "#/components/parameters/Date"
|
27
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
28
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
29
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
30
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
31
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
32
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
33
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
34
|
+
get:
|
35
|
+
description: >-
|
36
|
+
The HTTP request `GET /parties/{Type}/{ID}` (or `GET
|
37
|
+
/parties/{Type}/{ID}/{SubId}`) is used to look up information regarding
|
38
|
+
the requested Party, defined by `{Type}`, `{ID}` and optionally
|
39
|
+
`{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET
|
40
|
+
/parties/BUSINESS/shoecompany/employee1`).
|
41
|
+
summary: Look up party information
|
42
|
+
tags:
|
43
|
+
- parties
|
44
|
+
operationId: PartiesByTypeAndID
|
45
|
+
parameters:
|
46
|
+
- $ref: "#/components/parameters/Accept"
|
47
|
+
responses:
|
48
|
+
"202":
|
49
|
+
$ref: "#/components/responses/202"
|
50
|
+
"400":
|
51
|
+
$ref: "#/components/responses/400"
|
52
|
+
"401":
|
53
|
+
$ref: "#/components/responses/401"
|
54
|
+
"403":
|
55
|
+
$ref: "#/components/responses/403"
|
56
|
+
"404":
|
57
|
+
$ref: "#/components/responses/404"
|
58
|
+
"405":
|
59
|
+
$ref: "#/components/responses/405"
|
60
|
+
"406":
|
61
|
+
$ref: "#/components/responses/406"
|
62
|
+
"501":
|
63
|
+
$ref: "#/components/responses/501"
|
64
|
+
"503":
|
65
|
+
$ref: "#/components/responses/503"
|
66
|
+
put:
|
67
|
+
description: >-
|
68
|
+
The callback `PUT /parties/{Type}/{ID}` (or `PUT
|
69
|
+
/parties/{Type}/{ID}/{SubId}`) is used to inform the client of a
|
70
|
+
successful result of the Party information lookup.
|
71
|
+
summary: Return party information
|
72
|
+
tags:
|
73
|
+
- parties
|
74
|
+
operationId: PartiesByTypeAndID2
|
75
|
+
parameters:
|
76
|
+
- $ref: "#/components/parameters/Content-Length"
|
77
|
+
requestBody:
|
78
|
+
description: Party information returned.
|
79
|
+
required: true
|
80
|
+
content:
|
81
|
+
application/json:
|
82
|
+
schema:
|
83
|
+
$ref: >-
|
84
|
+
#/components/schemas/GetParties_IdentificationVerificationReportV03
|
85
|
+
responses:
|
86
|
+
"200":
|
87
|
+
$ref: "#/components/responses/200"
|
88
|
+
"400":
|
89
|
+
$ref: "#/components/responses/400"
|
90
|
+
"401":
|
91
|
+
$ref: "#/components/responses/401"
|
92
|
+
"403":
|
93
|
+
$ref: "#/components/responses/403"
|
94
|
+
"404":
|
95
|
+
$ref: "#/components/responses/404"
|
96
|
+
"405":
|
97
|
+
$ref: "#/components/responses/405"
|
98
|
+
"406":
|
99
|
+
$ref: "#/components/responses/406"
|
100
|
+
"501":
|
101
|
+
$ref: "#/components/responses/501"
|
102
|
+
"503":
|
103
|
+
$ref: "#/components/responses/503"
|
104
|
+
/parties/{Type}/{ID}/error:
|
105
|
+
put:
|
106
|
+
description: >-
|
107
|
+
If the server is unable to find Party information of the provided
|
108
|
+
identity, or another processing error occurred, the error callback `PUT
|
109
|
+
/parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`)
|
110
|
+
is used.
|
111
|
+
summary: Return party information error
|
112
|
+
tags:
|
113
|
+
- parties
|
114
|
+
operationId: PartiesErrorByTypeAndID
|
115
|
+
parameters:
|
116
|
+
- $ref: "#/components/parameters/Type"
|
117
|
+
- $ref: "#/components/parameters/ID"
|
118
|
+
- $ref: "#/components/parameters/Content-Length"
|
119
|
+
- $ref: "#/components/parameters/Content-Type"
|
120
|
+
- $ref: "#/components/parameters/Date"
|
121
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
122
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
123
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
124
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
125
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
126
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
127
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
128
|
+
requestBody:
|
129
|
+
description: Details of the error returned.
|
130
|
+
required: true
|
131
|
+
content:
|
132
|
+
application/json:
|
133
|
+
schema:
|
134
|
+
$ref: >-
|
135
|
+
#/components/schemas/GetPartiesError_IdentificationVerificationReportV03
|
136
|
+
responses:
|
137
|
+
"200":
|
138
|
+
$ref: "#/components/responses/200"
|
139
|
+
"400":
|
140
|
+
$ref: "#/components/responses/400"
|
141
|
+
"401":
|
142
|
+
$ref: "#/components/responses/401"
|
143
|
+
"403":
|
144
|
+
$ref: "#/components/responses/403"
|
145
|
+
"404":
|
146
|
+
$ref: "#/components/responses/404"
|
147
|
+
"405":
|
148
|
+
$ref: "#/components/responses/405"
|
149
|
+
"406":
|
150
|
+
$ref: "#/components/responses/406"
|
151
|
+
"501":
|
152
|
+
$ref: "#/components/responses/501"
|
153
|
+
"503":
|
154
|
+
$ref: "#/components/responses/503"
|
155
|
+
/parties/{Type}/{ID}/{SubId}:
|
156
|
+
parameters:
|
157
|
+
- $ref: "#/components/parameters/Type"
|
158
|
+
- $ref: "#/components/parameters/ID"
|
159
|
+
- $ref: "#/components/parameters/SubId"
|
160
|
+
- $ref: "#/components/parameters/Content-Type"
|
161
|
+
- $ref: "#/components/parameters/Date"
|
162
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
163
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
164
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
165
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
166
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
167
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
168
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
169
|
+
get:
|
170
|
+
description: >-
|
171
|
+
The HTTP request `GET /parties/{Type}/{ID}` (or `GET
|
172
|
+
/parties/{Type}/{ID}/{SubId}`) is used to look up information regarding
|
173
|
+
the requested Party, defined by `{Type}`, `{ID}` and optionally
|
174
|
+
`{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET
|
175
|
+
/parties/BUSINESS/shoecompany/employee1`).
|
176
|
+
summary: Look up party information
|
177
|
+
tags:
|
178
|
+
- parties
|
179
|
+
operationId: PartiesSubIdByTypeAndID
|
180
|
+
parameters:
|
181
|
+
- $ref: "#/components/parameters/Accept"
|
182
|
+
responses:
|
183
|
+
"202":
|
184
|
+
$ref: "#/components/responses/202"
|
185
|
+
"400":
|
186
|
+
$ref: "#/components/responses/400"
|
187
|
+
"401":
|
188
|
+
$ref: "#/components/responses/401"
|
189
|
+
"403":
|
190
|
+
$ref: "#/components/responses/403"
|
191
|
+
"404":
|
192
|
+
$ref: "#/components/responses/404"
|
193
|
+
"405":
|
194
|
+
$ref: "#/components/responses/405"
|
195
|
+
"406":
|
196
|
+
$ref: "#/components/responses/406"
|
197
|
+
"501":
|
198
|
+
$ref: "#/components/responses/501"
|
199
|
+
"503":
|
200
|
+
$ref: "#/components/responses/503"
|
201
|
+
put:
|
202
|
+
description: >-
|
203
|
+
The callback `PUT /parties/{Type}/{ID}` (or `PUT
|
204
|
+
/parties/{Type}/{ID}/{SubId}`) is used to inform the client of a
|
205
|
+
successful result of the Party information lookup.
|
206
|
+
summary: Return party information
|
207
|
+
tags:
|
208
|
+
- parties
|
209
|
+
operationId: PartiesSubIdByTypeAndIDPut
|
210
|
+
parameters:
|
211
|
+
- $ref: "#/components/parameters/Content-Length"
|
212
|
+
requestBody:
|
213
|
+
description: Party information returned.
|
214
|
+
required: true
|
215
|
+
content:
|
216
|
+
application/json:
|
217
|
+
schema:
|
218
|
+
$ref: >-
|
219
|
+
#/components/schemas/GetParties_IdentificationVerificationReportV03
|
220
|
+
responses:
|
221
|
+
"200":
|
222
|
+
$ref: "#/components/responses/200"
|
223
|
+
"400":
|
224
|
+
$ref: "#/components/responses/400"
|
225
|
+
"401":
|
226
|
+
$ref: "#/components/responses/401"
|
227
|
+
"403":
|
228
|
+
$ref: "#/components/responses/403"
|
229
|
+
"404":
|
230
|
+
$ref: "#/components/responses/404"
|
231
|
+
"405":
|
232
|
+
$ref: "#/components/responses/405"
|
233
|
+
"406":
|
234
|
+
$ref: "#/components/responses/406"
|
235
|
+
"501":
|
236
|
+
$ref: "#/components/responses/501"
|
237
|
+
"503":
|
238
|
+
$ref: "#/components/responses/503"
|
239
|
+
/parties/{Type}/{ID}/{SubId}/error:
|
240
|
+
put:
|
241
|
+
description: >-
|
242
|
+
If the server is unable to find Party information of the provided
|
243
|
+
identity, or another processing error occurred, the error callback `PUT
|
244
|
+
/parties/{Type}/{ID}/error` (or `PUT
|
245
|
+
/parties/{Type}/{ID}/{SubId}/error`) is used.
|
246
|
+
summary: Return party information error
|
247
|
+
tags:
|
248
|
+
- parties
|
249
|
+
operationId: PartiesSubIdErrorByTypeAndID
|
250
|
+
parameters:
|
251
|
+
- $ref: "#/components/parameters/Type"
|
252
|
+
- $ref: "#/components/parameters/ID"
|
253
|
+
- $ref: "#/components/parameters/SubId"
|
254
|
+
- $ref: "#/components/parameters/Content-Length"
|
255
|
+
- $ref: "#/components/parameters/Content-Type"
|
256
|
+
- $ref: "#/components/parameters/Date"
|
257
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
258
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
259
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
260
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
261
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
262
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
263
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
264
|
+
requestBody:
|
265
|
+
description: Details of the error returned.
|
266
|
+
required: true
|
267
|
+
content:
|
268
|
+
application/json:
|
269
|
+
schema:
|
270
|
+
$ref: >-
|
271
|
+
#/components/schemas/GetPartiesError_IdentificationVerificationReportV03
|
272
|
+
responses:
|
273
|
+
"200":
|
274
|
+
$ref: "#/components/responses/200"
|
275
|
+
"400":
|
276
|
+
$ref: "#/components/responses/400"
|
277
|
+
"401":
|
278
|
+
$ref: "#/components/responses/401"
|
279
|
+
"403":
|
280
|
+
$ref: "#/components/responses/403"
|
281
|
+
"404":
|
282
|
+
$ref: "#/components/responses/404"
|
283
|
+
"405":
|
284
|
+
$ref: "#/components/responses/405"
|
285
|
+
"406":
|
286
|
+
$ref: "#/components/responses/406"
|
287
|
+
"501":
|
288
|
+
$ref: "#/components/responses/501"
|
289
|
+
"503":
|
290
|
+
$ref: "#/components/responses/503"
|
291
|
+
/quotes:
|
292
|
+
post:
|
293
|
+
description: >-
|
294
|
+
The HTTP request `POST /quotes` is used to request the creation of a
|
295
|
+
quote for the provided financial transaction in the server.
|
296
|
+
summary: Calculate quote
|
297
|
+
tags:
|
298
|
+
- quotes
|
299
|
+
operationId: Quotes
|
300
|
+
parameters:
|
301
|
+
- $ref: "#/components/parameters/Accept"
|
302
|
+
- $ref: "#/components/parameters/Content-Length"
|
303
|
+
- $ref: "#/components/parameters/Content-Type"
|
304
|
+
- $ref: "#/components/parameters/Date"
|
305
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
306
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
307
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
308
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
309
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
310
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
311
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
312
|
+
requestBody:
|
313
|
+
description: Details of the quote to be created.
|
314
|
+
required: true
|
315
|
+
content:
|
316
|
+
application/json:
|
317
|
+
schema:
|
318
|
+
$ref: "#/components/schemas/TermsRequest_FIToFICustomerCreditProposal"
|
319
|
+
responses:
|
320
|
+
"202":
|
321
|
+
$ref: "#/components/responses/202"
|
322
|
+
"400":
|
323
|
+
$ref: "#/components/responses/400"
|
324
|
+
"401":
|
325
|
+
$ref: "#/components/responses/401"
|
326
|
+
"403":
|
327
|
+
$ref: "#/components/responses/403"
|
328
|
+
"404":
|
329
|
+
$ref: "#/components/responses/404"
|
330
|
+
"405":
|
331
|
+
$ref: "#/components/responses/405"
|
332
|
+
"406":
|
333
|
+
$ref: "#/components/responses/406"
|
334
|
+
"501":
|
335
|
+
$ref: "#/components/responses/501"
|
336
|
+
"503":
|
337
|
+
$ref: "#/components/responses/503"
|
338
|
+
/quotes/{ID}:
|
339
|
+
parameters:
|
340
|
+
- $ref: "#/components/parameters/ID"
|
341
|
+
- $ref: "#/components/parameters/Content-Type"
|
342
|
+
- $ref: "#/components/parameters/Date"
|
343
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
344
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
345
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
346
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
347
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
348
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
349
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
350
|
+
get:
|
351
|
+
description: >-
|
352
|
+
The HTTP request `GET /quotes/{ID}` is used to get information regarding
|
353
|
+
a quote created or requested earlier. The `{ID}` in the URI should
|
354
|
+
contain the `quoteId` that was used for the creation of the quote.
|
355
|
+
summary: Retrieve quote information
|
356
|
+
tags:
|
357
|
+
- quotes
|
358
|
+
operationId: QuotesByID
|
359
|
+
parameters:
|
360
|
+
- $ref: "#/components/parameters/Accept"
|
361
|
+
responses:
|
362
|
+
"202":
|
363
|
+
$ref: "#/components/responses/202"
|
364
|
+
"400":
|
365
|
+
$ref: "#/components/responses/400"
|
366
|
+
"401":
|
367
|
+
$ref: "#/components/responses/401"
|
368
|
+
"403":
|
369
|
+
$ref: "#/components/responses/403"
|
370
|
+
"404":
|
371
|
+
$ref: "#/components/responses/404"
|
372
|
+
"405":
|
373
|
+
$ref: "#/components/responses/405"
|
374
|
+
"406":
|
375
|
+
$ref: "#/components/responses/406"
|
376
|
+
"501":
|
377
|
+
$ref: "#/components/responses/501"
|
378
|
+
"503":
|
379
|
+
$ref: "#/components/responses/503"
|
380
|
+
put:
|
381
|
+
description: >-
|
382
|
+
The callback `PUT /quotes/{ID}` is used to inform the client of a
|
383
|
+
requested or created quote. The `{ID}` in the URI should contain the
|
384
|
+
`quoteId` that was used for the creation of the quote, or the `{ID}`
|
385
|
+
that was used in the `GET /quotes/{ID}` request.
|
386
|
+
summary: Return quote information
|
387
|
+
tags:
|
388
|
+
- quotes
|
389
|
+
operationId: QuotesByID1
|
390
|
+
parameters:
|
391
|
+
- $ref: "#/components/parameters/Content-Length"
|
392
|
+
requestBody:
|
393
|
+
description: Quote information returned.
|
394
|
+
required: true
|
395
|
+
content:
|
396
|
+
application/json:
|
397
|
+
schema:
|
398
|
+
$ref: >-
|
399
|
+
#/components/schemas/TermsResponse_FIToFICustomerCreditConfirmation
|
400
|
+
responses:
|
401
|
+
"200":
|
402
|
+
$ref: "#/components/responses/200"
|
403
|
+
"400":
|
404
|
+
$ref: "#/components/responses/400"
|
405
|
+
"401":
|
406
|
+
$ref: "#/components/responses/401"
|
407
|
+
"403":
|
408
|
+
$ref: "#/components/responses/403"
|
409
|
+
"404":
|
410
|
+
$ref: "#/components/responses/404"
|
411
|
+
"405":
|
412
|
+
$ref: "#/components/responses/405"
|
413
|
+
"406":
|
414
|
+
$ref: "#/components/responses/406"
|
415
|
+
"501":
|
416
|
+
$ref: "#/components/responses/501"
|
417
|
+
"503":
|
418
|
+
$ref: "#/components/responses/503"
|
419
|
+
/quotes/{ID}/error:
|
420
|
+
put:
|
421
|
+
description: >-
|
422
|
+
If the server is unable to find or create a quote, or some other
|
423
|
+
processing error occurs, the error callback `PUT /quotes/{ID}/error` is
|
424
|
+
used. The `{ID}` in the URI should contain the `quoteId` that was used
|
425
|
+
for the creation of the quote, or the `{ID}` that was used in the `GET
|
426
|
+
/quotes/{ID}` request.
|
427
|
+
summary: Return quote information error
|
428
|
+
tags:
|
429
|
+
- quotes
|
430
|
+
operationId: QuotesByIDAndError
|
431
|
+
parameters:
|
432
|
+
- $ref: "#/components/parameters/ID"
|
433
|
+
- $ref: "#/components/parameters/Content-Length"
|
434
|
+
- $ref: "#/components/parameters/Content-Type"
|
435
|
+
- $ref: "#/components/parameters/Date"
|
436
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
437
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
438
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
439
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
440
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
441
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
442
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
443
|
+
requestBody:
|
444
|
+
description: Details of the error returned.
|
445
|
+
required: true
|
446
|
+
content:
|
447
|
+
application/json:
|
448
|
+
schema:
|
449
|
+
$ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15"
|
450
|
+
responses:
|
451
|
+
"200":
|
452
|
+
$ref: "#/components/responses/200"
|
453
|
+
"400":
|
454
|
+
$ref: "#/components/responses/400"
|
455
|
+
"401":
|
456
|
+
$ref: "#/components/responses/401"
|
457
|
+
"403":
|
458
|
+
$ref: "#/components/responses/403"
|
459
|
+
"404":
|
460
|
+
$ref: "#/components/responses/404"
|
461
|
+
"405":
|
462
|
+
$ref: "#/components/responses/405"
|
463
|
+
"406":
|
464
|
+
$ref: "#/components/responses/406"
|
465
|
+
"501":
|
466
|
+
$ref: "#/components/responses/501"
|
467
|
+
"503":
|
468
|
+
$ref: "#/components/responses/503"
|
469
|
+
/transfers:
|
470
|
+
post:
|
471
|
+
description: >-
|
472
|
+
The HTTP request `POST /transfers` is used to request the creation of a
|
473
|
+
transfer for the next ledger, and a financial transaction for the Payee
|
474
|
+
FSP.
|
475
|
+
summary: Perform transfer
|
476
|
+
tags:
|
477
|
+
- transfers
|
478
|
+
operationId: transfers
|
479
|
+
parameters:
|
480
|
+
- $ref: "#/components/parameters/Accept"
|
481
|
+
- $ref: "#/components/parameters/Content-Length"
|
482
|
+
- $ref: "#/components/parameters/Content-Type"
|
483
|
+
- $ref: "#/components/parameters/Date"
|
484
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
485
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
486
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
487
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
488
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
489
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
490
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
491
|
+
requestBody:
|
492
|
+
description: Details of the transfer to be created.
|
493
|
+
required: true
|
494
|
+
content:
|
495
|
+
application/json:
|
496
|
+
schema:
|
497
|
+
$ref: "#/components/schemas/Execute_FIToFICustomerCreditTransferV13"
|
498
|
+
responses:
|
499
|
+
"202":
|
500
|
+
$ref: "#/components/responses/202"
|
501
|
+
"400":
|
502
|
+
$ref: "#/components/responses/400"
|
503
|
+
"401":
|
504
|
+
$ref: "#/components/responses/401"
|
505
|
+
"403":
|
506
|
+
$ref: "#/components/responses/403"
|
507
|
+
"404":
|
508
|
+
$ref: "#/components/responses/404"
|
509
|
+
"405":
|
510
|
+
$ref: "#/components/responses/405"
|
511
|
+
"406":
|
512
|
+
$ref: "#/components/responses/406"
|
513
|
+
"501":
|
514
|
+
$ref: "#/components/responses/501"
|
515
|
+
"503":
|
516
|
+
$ref: "#/components/responses/503"
|
517
|
+
/transfers/{ID}:
|
518
|
+
parameters:
|
519
|
+
- $ref: "#/components/parameters/ID"
|
520
|
+
- $ref: "#/components/parameters/Content-Type"
|
521
|
+
- $ref: "#/components/parameters/Date"
|
522
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
523
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
524
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
525
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
526
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
527
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
528
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
529
|
+
get:
|
530
|
+
description: >-
|
531
|
+
The HTTP request `GET /transfers/{ID}` is used to get information
|
532
|
+
regarding a transfer created or requested earlier. The `{ID}` in the URI
|
533
|
+
should contain the `transferId` that was used for the creation of the
|
534
|
+
transfer.
|
535
|
+
summary: Retrieve transfer information
|
536
|
+
tags:
|
537
|
+
- transfers
|
538
|
+
operationId: TransfersByIDGet
|
539
|
+
parameters:
|
540
|
+
- $ref: "#/components/parameters/Accept"
|
541
|
+
responses:
|
542
|
+
"202":
|
543
|
+
$ref: "#/components/responses/202"
|
544
|
+
"400":
|
545
|
+
$ref: "#/components/responses/400"
|
546
|
+
"401":
|
547
|
+
$ref: "#/components/responses/401"
|
548
|
+
"403":
|
549
|
+
$ref: "#/components/responses/403"
|
550
|
+
"404":
|
551
|
+
$ref: "#/components/responses/404"
|
552
|
+
"405":
|
553
|
+
$ref: "#/components/responses/405"
|
554
|
+
"406":
|
555
|
+
$ref: "#/components/responses/406"
|
556
|
+
"501":
|
557
|
+
$ref: "#/components/responses/501"
|
558
|
+
"503":
|
559
|
+
$ref: "#/components/responses/503"
|
560
|
+
patch:
|
561
|
+
description: >-
|
562
|
+
The HTTP request PATCH /transfers/<ID> is used by a Switch to update the
|
563
|
+
state of a previously reserved transfer, if the Payee FSP has requested
|
564
|
+
a commit notification when the Switch has completed processing of the
|
565
|
+
transfer. The <ID> in the URI should contain the transferId that was
|
566
|
+
used for the creation of the transfer. Please note that this request
|
567
|
+
does not generate a callback.
|
568
|
+
summary: Return transfer information
|
569
|
+
tags:
|
570
|
+
- transfers
|
571
|
+
operationId: TransfersByIDPatch
|
572
|
+
parameters:
|
573
|
+
- $ref: "#/components/parameters/Content-Length"
|
574
|
+
requestBody:
|
575
|
+
description: Transfer notification upon completion.
|
576
|
+
required: true
|
577
|
+
content:
|
578
|
+
application/json:
|
579
|
+
schema:
|
580
|
+
$ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15"
|
581
|
+
responses:
|
582
|
+
"200":
|
583
|
+
$ref: "#/components/responses/200"
|
584
|
+
"400":
|
585
|
+
$ref: "#/components/responses/400"
|
586
|
+
"401":
|
587
|
+
$ref: "#/components/responses/401"
|
588
|
+
"403":
|
589
|
+
$ref: "#/components/responses/403"
|
590
|
+
"404":
|
591
|
+
$ref: "#/components/responses/404"
|
592
|
+
"405":
|
593
|
+
$ref: "#/components/responses/405"
|
594
|
+
"406":
|
595
|
+
$ref: "#/components/responses/406"
|
596
|
+
"501":
|
597
|
+
$ref: "#/components/responses/501"
|
598
|
+
"503":
|
599
|
+
$ref: "#/components/responses/503"
|
600
|
+
put:
|
601
|
+
description: >-
|
602
|
+
The callback `PUT /transfers/{ID}` is used to inform the client of a
|
603
|
+
requested or created transfer. The `{ID}` in the URI should contain the
|
604
|
+
`transferId` that was used for the creation of the transfer, or the
|
605
|
+
`{ID}` that was used in the `GET /transfers/{ID}` request.
|
606
|
+
summary: Return transfer information
|
607
|
+
tags:
|
608
|
+
- transfers
|
609
|
+
operationId: TransfersByIDPut
|
610
|
+
parameters:
|
611
|
+
- $ref: "#/components/parameters/Content-Length"
|
612
|
+
requestBody:
|
613
|
+
description: Transfer information returned.
|
614
|
+
required: true
|
615
|
+
content:
|
616
|
+
application/json:
|
617
|
+
schema:
|
618
|
+
$ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15"
|
619
|
+
responses:
|
620
|
+
"200":
|
621
|
+
$ref: "#/components/responses/200"
|
622
|
+
"400":
|
623
|
+
$ref: "#/components/responses/400"
|
624
|
+
"401":
|
625
|
+
$ref: "#/components/responses/401"
|
626
|
+
"403":
|
627
|
+
$ref: "#/components/responses/403"
|
628
|
+
"404":
|
629
|
+
$ref: "#/components/responses/404"
|
630
|
+
"405":
|
631
|
+
$ref: "#/components/responses/405"
|
632
|
+
"406":
|
633
|
+
$ref: "#/components/responses/406"
|
634
|
+
"501":
|
635
|
+
$ref: "#/components/responses/501"
|
636
|
+
"503":
|
637
|
+
$ref: "#/components/responses/503"
|
638
|
+
/transfers/{ID}/error:
|
639
|
+
put:
|
640
|
+
description: >-
|
641
|
+
If the server is unable to find or create a transfer, or another
|
642
|
+
processing error occurs, the error callback `PUT /transfers/{ID}/error`
|
643
|
+
is used. The `{ID}` in the URI should contain the `transferId` that was
|
644
|
+
used for the creation of the transfer, or the `{ID}` that was used in
|
645
|
+
the `GET /transfers/{ID}`.
|
646
|
+
summary: Return transfer information error
|
647
|
+
tags:
|
648
|
+
- transfers
|
649
|
+
operationId: TransfersByIDAndError
|
650
|
+
parameters:
|
651
|
+
- $ref: "#/components/parameters/ID"
|
652
|
+
- $ref: "#/components/parameters/Content-Length"
|
653
|
+
- $ref: "#/components/parameters/Content-Type"
|
654
|
+
- $ref: "#/components/parameters/Date"
|
655
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
656
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
657
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
658
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
659
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
660
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
661
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
662
|
+
requestBody:
|
663
|
+
description: Details of the error returned.
|
664
|
+
required: true
|
665
|
+
content:
|
666
|
+
application/json:
|
667
|
+
schema:
|
668
|
+
$ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15"
|
669
|
+
responses:
|
670
|
+
"200":
|
671
|
+
$ref: "#/components/responses/200"
|
672
|
+
"400":
|
673
|
+
$ref: "#/components/responses/400"
|
674
|
+
"401":
|
675
|
+
$ref: "#/components/responses/401"
|
676
|
+
"403":
|
677
|
+
$ref: "#/components/responses/403"
|
678
|
+
"404":
|
679
|
+
$ref: "#/components/responses/404"
|
680
|
+
"405":
|
681
|
+
$ref: "#/components/responses/405"
|
682
|
+
"406":
|
683
|
+
$ref: "#/components/responses/406"
|
684
|
+
"501":
|
685
|
+
$ref: "#/components/responses/501"
|
686
|
+
"503":
|
687
|
+
$ref: "#/components/responses/503"
|
688
|
+
/fxQuotes:
|
689
|
+
post:
|
690
|
+
description: >-
|
691
|
+
The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a
|
692
|
+
quotation for a currency conversion.
|
693
|
+
summary: Calculate FX quote
|
694
|
+
tags:
|
695
|
+
- fxQuotes
|
696
|
+
operationId: FxQuotesPost
|
697
|
+
parameters:
|
698
|
+
- $ref: "#/components/parameters/Accept"
|
699
|
+
- $ref: "#/components/parameters/Content-Length"
|
700
|
+
- $ref: "#/components/parameters/Content-Type"
|
701
|
+
- $ref: "#/components/parameters/Date"
|
702
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
703
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
704
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
705
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
706
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
707
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
708
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
709
|
+
requestBody:
|
710
|
+
description: Details of the FX quote to be created.
|
711
|
+
required: true
|
712
|
+
content:
|
713
|
+
application/json:
|
714
|
+
schema:
|
715
|
+
$ref: "#/components/schemas/FxRequest_FICreditTransferProposal"
|
716
|
+
responses:
|
717
|
+
"202":
|
718
|
+
$ref: "#/components/responses/202"
|
719
|
+
"400":
|
720
|
+
$ref: "#/components/responses/400"
|
721
|
+
"401":
|
722
|
+
$ref: "#/components/responses/401"
|
723
|
+
"403":
|
724
|
+
$ref: "#/components/responses/403"
|
725
|
+
"404":
|
726
|
+
$ref: "#/components/responses/404"
|
727
|
+
"405":
|
728
|
+
$ref: "#/components/responses/405"
|
729
|
+
"406":
|
730
|
+
$ref: "#/components/responses/406"
|
731
|
+
"501":
|
732
|
+
$ref: "#/components/responses/501"
|
733
|
+
"503":
|
734
|
+
$ref: "#/components/responses/503"
|
735
|
+
/fxQuotes/{ID}:
|
736
|
+
parameters:
|
737
|
+
- $ref: "#/components/parameters/ID"
|
738
|
+
- $ref: "#/components/parameters/Content-Type"
|
739
|
+
- $ref: "#/components/parameters/Date"
|
740
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
741
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
742
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
743
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
744
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
745
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
746
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
747
|
+
get:
|
748
|
+
description: >-
|
749
|
+
The HTTP request `GET /fxQuotes/{ID}` is used to request information
|
750
|
+
regarding a request for quotation for a currency conversion which the
|
751
|
+
sender has previously issued. The `{ID}` in the URI should contain the
|
752
|
+
`conversionRequestId` that was used for the creation of the quote.
|
753
|
+
summary: Retrieve FX quote information
|
754
|
+
tags:
|
755
|
+
- fxQuotes
|
756
|
+
operationId: FxQuotesByIDGet
|
757
|
+
parameters:
|
758
|
+
- $ref: "#/components/parameters/Accept"
|
759
|
+
responses:
|
760
|
+
"202":
|
761
|
+
$ref: "#/components/responses/202"
|
762
|
+
"400":
|
763
|
+
$ref: "#/components/responses/400"
|
764
|
+
"401":
|
765
|
+
$ref: "#/components/responses/401"
|
766
|
+
"403":
|
767
|
+
$ref: "#/components/responses/403"
|
768
|
+
"404":
|
769
|
+
$ref: "#/components/responses/404"
|
770
|
+
"405":
|
771
|
+
$ref: "#/components/responses/405"
|
772
|
+
"406":
|
773
|
+
$ref: "#/components/responses/406"
|
774
|
+
"501":
|
775
|
+
$ref: "#/components/responses/501"
|
776
|
+
"503":
|
777
|
+
$ref: "#/components/responses/503"
|
778
|
+
put:
|
779
|
+
description: >-
|
780
|
+
The callback `PUT /fxQuotes/{ID}` is used to inform the requester about
|
781
|
+
the outcome of a request for quotation for a currency conversion. The
|
782
|
+
`{ID}` in the URI should contain the `conversionRequestId` that was used
|
783
|
+
for the creation of the FX quote, or the `{ID}` that was used in the
|
784
|
+
`GET /fxQuotes/{ID}` request.
|
785
|
+
summary: Return FX quote information
|
786
|
+
tags:
|
787
|
+
- fxQuotes
|
788
|
+
operationId: FxQuotesByIdPut
|
789
|
+
parameters:
|
790
|
+
- $ref: "#/components/parameters/Content-Length"
|
791
|
+
requestBody:
|
792
|
+
description: FX Quote information returned.
|
793
|
+
required: true
|
794
|
+
content:
|
795
|
+
application/json:
|
796
|
+
schema:
|
797
|
+
$ref: "#/components/schemas/FxResponse_FICreditTransferConfirmation"
|
798
|
+
responses:
|
799
|
+
"200":
|
800
|
+
$ref: "#/components/responses/200"
|
801
|
+
"400":
|
802
|
+
$ref: "#/components/responses/400"
|
803
|
+
"401":
|
804
|
+
$ref: "#/components/responses/401"
|
805
|
+
"403":
|
806
|
+
$ref: "#/components/responses/403"
|
807
|
+
"404":
|
808
|
+
$ref: "#/components/responses/404"
|
809
|
+
"405":
|
810
|
+
$ref: "#/components/responses/405"
|
811
|
+
"406":
|
812
|
+
$ref: "#/components/responses/406"
|
813
|
+
"501":
|
814
|
+
$ref: "#/components/responses/501"
|
815
|
+
"503":
|
816
|
+
$ref: "#/components/responses/503"
|
817
|
+
/fxQuotes/{ID}/error:
|
818
|
+
put:
|
819
|
+
description: >-
|
820
|
+
If the FXP is unable to find or create a FX quote, or some other
|
821
|
+
processing error occurs, the error callback `PUT /fxQuotes/{ID}/error`
|
822
|
+
is used. The `{ID}` in the URI should contain the `conversionRequestId`
|
823
|
+
that was used for the creation of the FX quote, or the `{ID}` that was
|
824
|
+
used in the `GET /fxQuotes/{ID}` request.
|
825
|
+
summary: Return FX quote information error
|
826
|
+
tags:
|
827
|
+
- fxQuotes
|
828
|
+
operationId: FxQuotesByIDAndErrorPut
|
829
|
+
parameters:
|
830
|
+
- $ref: "#/components/parameters/ID"
|
831
|
+
- $ref: "#/components/parameters/Content-Length"
|
832
|
+
- $ref: "#/components/parameters/Content-Type"
|
833
|
+
- $ref: "#/components/parameters/Date"
|
834
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
835
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
836
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
837
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
838
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
839
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
840
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
841
|
+
requestBody:
|
842
|
+
description: Details of the error returned.
|
843
|
+
required: true
|
844
|
+
content:
|
845
|
+
application/json:
|
846
|
+
schema:
|
847
|
+
$ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15"
|
848
|
+
responses:
|
849
|
+
"200":
|
850
|
+
$ref: "#/components/responses/200"
|
851
|
+
"400":
|
852
|
+
$ref: "#/components/responses/400"
|
853
|
+
"401":
|
854
|
+
$ref: "#/components/responses/401"
|
855
|
+
"403":
|
856
|
+
$ref: "#/components/responses/403"
|
857
|
+
"404":
|
858
|
+
$ref: "#/components/responses/404"
|
859
|
+
"405":
|
860
|
+
$ref: "#/components/responses/405"
|
861
|
+
"406":
|
862
|
+
$ref: "#/components/responses/406"
|
863
|
+
"501":
|
864
|
+
$ref: "#/components/responses/501"
|
865
|
+
"503":
|
866
|
+
$ref: "#/components/responses/503"
|
867
|
+
/fxTransfers:
|
868
|
+
post:
|
869
|
+
description: >-
|
870
|
+
The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm
|
871
|
+
the execution of an agreed currency conversion.
|
872
|
+
summary: Perform FX transfer
|
873
|
+
tags:
|
874
|
+
- fxTransfers
|
875
|
+
operationId: FxTransfersPost
|
876
|
+
parameters:
|
877
|
+
- $ref: "#/components/parameters/Accept"
|
878
|
+
- $ref: "#/components/parameters/Content-Length"
|
879
|
+
- $ref: "#/components/parameters/Content-Type"
|
880
|
+
- $ref: "#/components/parameters/Date"
|
881
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
882
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
883
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
884
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
885
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
886
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
887
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
888
|
+
requestBody:
|
889
|
+
description: Details of the FX transfer to be created.
|
890
|
+
required: true
|
891
|
+
content:
|
892
|
+
application/json:
|
893
|
+
schema:
|
894
|
+
$ref: >-
|
895
|
+
#/components/schemas/Fxecute_FinancialInstitutionCreditTransferV12
|
896
|
+
responses:
|
897
|
+
"202":
|
898
|
+
$ref: "#/components/responses/202"
|
899
|
+
"400":
|
900
|
+
$ref: "#/components/responses/400"
|
901
|
+
"401":
|
902
|
+
$ref: "#/components/responses/401"
|
903
|
+
"403":
|
904
|
+
$ref: "#/components/responses/403"
|
905
|
+
"404":
|
906
|
+
$ref: "#/components/responses/404"
|
907
|
+
"405":
|
908
|
+
$ref: "#/components/responses/405"
|
909
|
+
"406":
|
910
|
+
$ref: "#/components/responses/406"
|
911
|
+
"501":
|
912
|
+
$ref: "#/components/responses/501"
|
913
|
+
"503":
|
914
|
+
$ref: "#/components/responses/503"
|
915
|
+
/fxTransfers/{ID}:
|
916
|
+
parameters:
|
917
|
+
- $ref: "#/components/parameters/ID"
|
918
|
+
- $ref: "#/components/parameters/Content-Type"
|
919
|
+
- $ref: "#/components/parameters/Date"
|
920
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
921
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
922
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
923
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
924
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
925
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
926
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
927
|
+
get:
|
928
|
+
description: >-
|
929
|
+
The HTTP request `GET /fxTransfers/{ID}` s used to request information
|
930
|
+
regarding a request for confirmation of a currency conversion which the
|
931
|
+
sender has previously issued. The `{ID}` in the URI should contain the
|
932
|
+
`commitRequestId` that was used for the creation of the FX transfer.
|
933
|
+
summary: Retrieve FX transfer information
|
934
|
+
tags:
|
935
|
+
- fxTransfers
|
936
|
+
operationId: FxTransfersByIDGet
|
937
|
+
parameters:
|
938
|
+
- $ref: "#/components/parameters/Accept"
|
939
|
+
responses:
|
940
|
+
"202":
|
941
|
+
$ref: "#/components/responses/202"
|
942
|
+
"400":
|
943
|
+
$ref: "#/components/responses/400"
|
944
|
+
"401":
|
945
|
+
$ref: "#/components/responses/401"
|
946
|
+
"403":
|
947
|
+
$ref: "#/components/responses/403"
|
948
|
+
"404":
|
949
|
+
$ref: "#/components/responses/404"
|
950
|
+
"405":
|
951
|
+
$ref: "#/components/responses/405"
|
952
|
+
"406":
|
953
|
+
$ref: "#/components/responses/406"
|
954
|
+
"501":
|
955
|
+
$ref: "#/components/responses/501"
|
956
|
+
"503":
|
957
|
+
$ref: "#/components/responses/503"
|
958
|
+
patch:
|
959
|
+
description: >-
|
960
|
+
The HTTP request PATCH /fxTransfers/<ID> is used to inform the requester
|
961
|
+
about the final determination by the switch of the transfer a request
|
962
|
+
for execution of a currency conversion. The <ID> in the URI should
|
963
|
+
contain the commitRequestId that was used for the creation of the FX
|
964
|
+
transfer. Please note that this request does not generate a callback.
|
965
|
+
summary: Return FX transfer information
|
966
|
+
tags:
|
967
|
+
- fxTransfers
|
968
|
+
operationId: FxTransfersByIDPatch
|
969
|
+
parameters:
|
970
|
+
- $ref: "#/components/parameters/Content-Length"
|
971
|
+
requestBody:
|
972
|
+
description: Transfer notification upon completion.
|
973
|
+
required: true
|
974
|
+
content:
|
975
|
+
application/json:
|
976
|
+
schema:
|
977
|
+
$ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15"
|
978
|
+
responses:
|
979
|
+
"200":
|
980
|
+
$ref: "#/components/responses/200"
|
981
|
+
"400":
|
982
|
+
$ref: "#/components/responses/400"
|
983
|
+
"401":
|
984
|
+
$ref: "#/components/responses/401"
|
985
|
+
"403":
|
986
|
+
$ref: "#/components/responses/403"
|
987
|
+
"404":
|
988
|
+
$ref: "#/components/responses/404"
|
989
|
+
"405":
|
990
|
+
$ref: "#/components/responses/405"
|
991
|
+
"406":
|
992
|
+
$ref: "#/components/responses/406"
|
993
|
+
"501":
|
994
|
+
$ref: "#/components/responses/501"
|
995
|
+
"503":
|
996
|
+
$ref: "#/components/responses/503"
|
997
|
+
put:
|
998
|
+
description: >-
|
999
|
+
The callback `PUT /fxTransfers/{ID}` is used to inform the requester
|
1000
|
+
about the outcome of a request for execution of a currency conversion.
|
1001
|
+
The `{ID}` in the URI should contain the `commitRequestId` that was used
|
1002
|
+
for the creation of the FX transfer, or the `{ID}` that was used in the
|
1003
|
+
`GET /fxTransfers/{ID}` request.
|
1004
|
+
summary: Return FX transfer information
|
1005
|
+
tags:
|
1006
|
+
- fxTransfers
|
1007
|
+
operationId: FxTransfersByIDPut
|
1008
|
+
parameters:
|
1009
|
+
- $ref: "#/components/parameters/Content-Length"
|
1010
|
+
requestBody:
|
1011
|
+
description: Transfer information returned.
|
1012
|
+
required: true
|
1013
|
+
content:
|
1014
|
+
application/json:
|
1015
|
+
schema:
|
1016
|
+
$ref: "#/components/schemas/PacsStatus_FIToFIPaymentStatusReportV15"
|
1017
|
+
responses:
|
1018
|
+
"200":
|
1019
|
+
$ref: "#/components/responses/200"
|
1020
|
+
"400":
|
1021
|
+
$ref: "#/components/responses/400"
|
1022
|
+
"401":
|
1023
|
+
$ref: "#/components/responses/401"
|
1024
|
+
"403":
|
1025
|
+
$ref: "#/components/responses/403"
|
1026
|
+
"404":
|
1027
|
+
$ref: "#/components/responses/404"
|
1028
|
+
"405":
|
1029
|
+
$ref: "#/components/responses/405"
|
1030
|
+
"406":
|
1031
|
+
$ref: "#/components/responses/406"
|
1032
|
+
"501":
|
1033
|
+
$ref: "#/components/responses/501"
|
1034
|
+
"503":
|
1035
|
+
$ref: "#/components/responses/503"
|
1036
|
+
/fxTransfers/{ID}/error:
|
1037
|
+
put:
|
1038
|
+
description: >-
|
1039
|
+
If the switch or FXP is unable to find or create a FX transfer, or
|
1040
|
+
another processing error occurs, the error callback `PUT
|
1041
|
+
/fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain
|
1042
|
+
the `commitRequestId` that was used for the creation of the FX transfer,
|
1043
|
+
or the `{ID}` that was used in the `GET /fxTransfers/{ID}`.
|
1044
|
+
summary: Return FX transfer information error
|
1045
|
+
tags:
|
1046
|
+
- fxTransfers
|
1047
|
+
operationId: FxTransfersByIDAndErrorPut
|
1048
|
+
parameters:
|
1049
|
+
- $ref: "#/components/parameters/ID"
|
1050
|
+
- $ref: "#/components/parameters/Content-Length"
|
1051
|
+
- $ref: "#/components/parameters/Content-Type"
|
1052
|
+
- $ref: "#/components/parameters/Date"
|
1053
|
+
- $ref: "#/components/parameters/X-Forwarded-For"
|
1054
|
+
- $ref: "#/components/parameters/FSPIOP-Source"
|
1055
|
+
- $ref: "#/components/parameters/FSPIOP-Destination"
|
1056
|
+
- $ref: "#/components/parameters/FSPIOP-Encryption"
|
1057
|
+
- $ref: "#/components/parameters/FSPIOP-Signature"
|
1058
|
+
- $ref: "#/components/parameters/FSPIOP-URI"
|
1059
|
+
- $ref: "#/components/parameters/FSPIOP-HTTP-Method"
|
1060
|
+
requestBody:
|
1061
|
+
description: Details of the error returned.
|
1062
|
+
required: true
|
1063
|
+
content:
|
1064
|
+
application/json:
|
1065
|
+
schema:
|
1066
|
+
$ref: "#/components/schemas/PacsError_FIToFIPaymentStatusReportV15"
|
1067
|
+
responses:
|
1068
|
+
"200":
|
1069
|
+
$ref: "#/components/responses/200"
|
1070
|
+
"400":
|
1071
|
+
$ref: "#/components/responses/400"
|
1072
|
+
"401":
|
1073
|
+
$ref: "#/components/responses/401"
|
1074
|
+
"403":
|
1075
|
+
$ref: "#/components/responses/403"
|
1076
|
+
"404":
|
1077
|
+
$ref: "#/components/responses/404"
|
1078
|
+
"405":
|
1079
|
+
$ref: "#/components/responses/405"
|
1080
|
+
"406":
|
1081
|
+
$ref: "#/components/responses/406"
|
1082
|
+
"501":
|
1083
|
+
$ref: "#/components/responses/501"
|
1084
|
+
"503":
|
1085
|
+
$ref: "#/components/responses/503"
|
1086
|
+
components:
|
1087
|
+
parameters:
|
1088
|
+
Accept:
|
1089
|
+
name: Accept
|
1090
|
+
in: header
|
1091
|
+
required: true
|
1092
|
+
schema:
|
1093
|
+
type: string
|
1094
|
+
description: >-
|
1095
|
+
The `Accept` header field indicates the version of the API the client
|
1096
|
+
would like the server to use.
|
1097
|
+
Content-Length:
|
1098
|
+
name: Content-Length
|
1099
|
+
in: header
|
1100
|
+
required: false
|
1101
|
+
schema:
|
1102
|
+
type: integer
|
1103
|
+
description: >-
|
1104
|
+
The `Content-Length` header field indicates the anticipated size of the
|
1105
|
+
payload body. Only sent if there is a body.
|
1106
|
+
|
1107
|
+
|
1108
|
+
**Note:** The API supports a maximum size of 5242880 bytes (5
|
1109
|
+
Megabytes).
|
1110
|
+
Content-Type:
|
1111
|
+
name: Content-Type
|
1112
|
+
in: header
|
1113
|
+
schema:
|
1114
|
+
type: string
|
1115
|
+
required: true
|
1116
|
+
description: >-
|
1117
|
+
The `Content-Type` header indicates the specific version of the API used
|
1118
|
+
to send the payload body.
|
1119
|
+
Date:
|
1120
|
+
name: Date
|
1121
|
+
in: header
|
1122
|
+
schema:
|
1123
|
+
type: string
|
1124
|
+
required: true
|
1125
|
+
description: The `Date` header field indicates the date when the request was sent.
|
1126
|
+
FSPIOP-Destination:
|
1127
|
+
name: FSPIOP-Destination
|
1128
|
+
in: header
|
1129
|
+
schema:
|
1130
|
+
type: string
|
1131
|
+
required: false
|
1132
|
+
description: >-
|
1133
|
+
The `FSPIOP-Destination` header field is a non-HTTP standard field used
|
1134
|
+
by the API for HTTP header based routing of requests and responses to
|
1135
|
+
the destination. The field must be set by the original sender of the
|
1136
|
+
request if the destination is known (valid for all services except GET
|
1137
|
+
/parties) so that any entities between the client and the server do not
|
1138
|
+
need to parse the payload for routing purposes. If the destination is
|
1139
|
+
not known (valid for service GET /parties), the field should be left
|
1140
|
+
empty.
|
1141
|
+
FSPIOP-Encryption:
|
1142
|
+
name: FSPIOP-Encryption
|
1143
|
+
in: header
|
1144
|
+
schema:
|
1145
|
+
type: string
|
1146
|
+
required: false
|
1147
|
+
description: >-
|
1148
|
+
The `FSPIOP-Encryption` header field is a non-HTTP standard field used
|
1149
|
+
by the API for applying end-to-end encryption of the request.
|
1150
|
+
FSPIOP-HTTP-Method:
|
1151
|
+
name: FSPIOP-HTTP-Method
|
1152
|
+
in: header
|
1153
|
+
schema:
|
1154
|
+
type: string
|
1155
|
+
required: false
|
1156
|
+
description: >-
|
1157
|
+
The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used
|
1158
|
+
by the API for signature verification, should contain the service HTTP
|
1159
|
+
method. Required if signature verification is used, for more
|
1160
|
+
information, see [the API Signature
|
1161
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
1162
|
+
FSPIOP-Signature:
|
1163
|
+
name: FSPIOP-Signature
|
1164
|
+
in: header
|
1165
|
+
schema:
|
1166
|
+
type: string
|
1167
|
+
required: false
|
1168
|
+
description: >-
|
1169
|
+
The `FSPIOP-Signature` header field is a non-HTTP standard field used by
|
1170
|
+
the API for applying an end-to-end request signature.
|
1171
|
+
FSPIOP-Source:
|
1172
|
+
name: FSPIOP-Source
|
1173
|
+
in: header
|
1174
|
+
schema:
|
1175
|
+
type: string
|
1176
|
+
required: true
|
1177
|
+
description: >-
|
1178
|
+
The `FSPIOP-Source` header field is a non-HTTP standard field used by
|
1179
|
+
the API for identifying the sender of the HTTP request. The field should
|
1180
|
+
be set by the original sender of the request. Required for routing and
|
1181
|
+
signature verification (see header field `FSPIOP-Signature`).
|
1182
|
+
FSPIOP-URI:
|
1183
|
+
name: FSPIOP-URI
|
1184
|
+
in: header
|
1185
|
+
schema:
|
1186
|
+
type: string
|
1187
|
+
required: false
|
1188
|
+
description: >-
|
1189
|
+
The `FSPIOP-URI` header field is a non-HTTP standard field used by the
|
1190
|
+
API for signature verification, should contain the service URI. Required
|
1191
|
+
if signature verification is used, for more information, see [the API
|
1192
|
+
Signature
|
1193
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
1194
|
+
ID:
|
1195
|
+
name: ID
|
1196
|
+
in: path
|
1197
|
+
required: true
|
1198
|
+
schema:
|
1199
|
+
type: string
|
1200
|
+
description: The identifier value.
|
1201
|
+
SubId:
|
1202
|
+
name: SubId
|
1203
|
+
in: path
|
1204
|
+
required: true
|
1205
|
+
schema:
|
1206
|
+
type: string
|
1207
|
+
description: >-
|
1208
|
+
A sub-identifier of the party identifier, or a sub-type of the party
|
1209
|
+
identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
1210
|
+
Type:
|
1211
|
+
name: Type
|
1212
|
+
in: path
|
1213
|
+
required: true
|
1214
|
+
schema:
|
1215
|
+
type: string
|
1216
|
+
description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
|
1217
|
+
X-Forwarded-For:
|
1218
|
+
name: X-Forwarded-For
|
1219
|
+
in: header
|
1220
|
+
schema:
|
1221
|
+
type: string
|
1222
|
+
required: false
|
1223
|
+
description: >-
|
1224
|
+
The `X-Forwarded-For` header field is an unofficially accepted standard
|
1225
|
+
used for informational purposes of the originating client IP address, as
|
1226
|
+
a request might pass multiple proxies, firewalls, and so on. Multiple
|
1227
|
+
`X-Forwarded-For` values should be expected and supported by
|
1228
|
+
implementers of the API.
|
1229
|
+
|
1230
|
+
|
1231
|
+
**Note:** An alternative to `X-Forwarded-For` is defined in [RFC
|
1232
|
+
7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC
|
1233
|
+
7239 is less-used and supported than `X-Forwarded-For`.
|
1234
|
+
responses:
|
1235
|
+
"200":
|
1236
|
+
description: OK
|
1237
|
+
"202":
|
1238
|
+
description: Accepted
|
1239
|
+
"400":
|
1240
|
+
description: Bad Request
|
1241
|
+
content:
|
1242
|
+
application/json:
|
1243
|
+
schema:
|
1244
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1245
|
+
headers:
|
1246
|
+
Content-Length:
|
1247
|
+
$ref: "#/components/headers/Content-Length"
|
1248
|
+
Content-Type:
|
1249
|
+
$ref: "#/components/headers/Content-Type"
|
1250
|
+
"401":
|
1251
|
+
description: Unauthorized
|
1252
|
+
content:
|
1253
|
+
application/json:
|
1254
|
+
schema:
|
1255
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1256
|
+
headers:
|
1257
|
+
Content-Length:
|
1258
|
+
$ref: "#/components/headers/Content-Length"
|
1259
|
+
Content-Type:
|
1260
|
+
$ref: "#/components/headers/Content-Type"
|
1261
|
+
"403":
|
1262
|
+
description: Forbidden
|
1263
|
+
content:
|
1264
|
+
application/json:
|
1265
|
+
schema:
|
1266
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1267
|
+
headers:
|
1268
|
+
Content-Length:
|
1269
|
+
$ref: "#/components/headers/Content-Length"
|
1270
|
+
Content-Type:
|
1271
|
+
$ref: "#/components/headers/Content-Type"
|
1272
|
+
"404":
|
1273
|
+
description: Not Found
|
1274
|
+
content:
|
1275
|
+
application/json:
|
1276
|
+
schema:
|
1277
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1278
|
+
headers:
|
1279
|
+
Content-Length:
|
1280
|
+
$ref: "#/components/headers/Content-Length"
|
1281
|
+
Content-Type:
|
1282
|
+
$ref: "#/components/headers/Content-Type"
|
1283
|
+
"405":
|
1284
|
+
description: Method Not Allowed
|
1285
|
+
content:
|
1286
|
+
application/json:
|
1287
|
+
schema:
|
1288
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1289
|
+
headers:
|
1290
|
+
Content-Length:
|
1291
|
+
$ref: "#/components/headers/Content-Length"
|
1292
|
+
Content-Type:
|
1293
|
+
$ref: "#/components/headers/Content-Type"
|
1294
|
+
"406":
|
1295
|
+
description: Not Acceptable
|
1296
|
+
content:
|
1297
|
+
application/json:
|
1298
|
+
schema:
|
1299
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1300
|
+
headers:
|
1301
|
+
Content-Length:
|
1302
|
+
$ref: "#/components/headers/Content-Length"
|
1303
|
+
Content-Type:
|
1304
|
+
$ref: "#/components/headers/Content-Type"
|
1305
|
+
"501":
|
1306
|
+
description: Not Implemented
|
1307
|
+
content:
|
1308
|
+
application/json:
|
1309
|
+
schema:
|
1310
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1311
|
+
headers:
|
1312
|
+
Content-Length:
|
1313
|
+
$ref: "#/components/headers/Content-Length"
|
1314
|
+
Content-Type:
|
1315
|
+
$ref: "#/components/headers/Content-Type"
|
1316
|
+
"503":
|
1317
|
+
description: Service Unavailable
|
1318
|
+
content:
|
1319
|
+
application/json:
|
1320
|
+
schema:
|
1321
|
+
$ref: "#/components/schemas/ErrorInformationResponse"
|
1322
|
+
headers:
|
1323
|
+
Content-Length:
|
1324
|
+
$ref: "#/components/headers/Content-Length"
|
1325
|
+
Content-Type:
|
1326
|
+
$ref: "#/components/headers/Content-Type"
|
1327
|
+
headers:
|
1328
|
+
Content-Length:
|
1329
|
+
required: false
|
1330
|
+
schema:
|
1331
|
+
type: integer
|
1332
|
+
description: >-
|
1333
|
+
The `Content-Length` header field indicates the anticipated size of the
|
1334
|
+
payload body. Only sent if there is a body.
|
1335
|
+
|
1336
|
+
|
1337
|
+
**Note:** The API supports a maximum size of 5242880 bytes (5
|
1338
|
+
Megabytes).
|
1339
|
+
Content-Type:
|
1340
|
+
schema:
|
1341
|
+
type: string
|
1342
|
+
required: true
|
1343
|
+
description: >-
|
1344
|
+
The `Content-Type` header indicates the specific version of the API used
|
1345
|
+
to send the payload body.
|
1346
|
+
schemas:
|
1347
|
+
AccountIdentification4Choice:
|
1348
|
+
title: AccountIdentification4Choice
|
1349
|
+
type: object
|
1350
|
+
description: >
|
1351
|
+
Specifies the unique identification of an account as assigned by the
|
1352
|
+
account servicer.
|
1353
|
+
properties:
|
1354
|
+
IBAN:
|
1355
|
+
$ref: "#/components/schemas/IBAN2007Identifier"
|
1356
|
+
Othr:
|
1357
|
+
$ref: "#/components/schemas/GenericAccountIdentification1"
|
1358
|
+
oneOf:
|
1359
|
+
- required:
|
1360
|
+
- IBAN
|
1361
|
+
- required:
|
1362
|
+
- Othr
|
1363
|
+
example:
|
1364
|
+
IBAN: BE71096123456769
|
1365
|
+
AccountSchemeName1Choice:
|
1366
|
+
title: AccountSchemeName1Choice
|
1367
|
+
type: object
|
1368
|
+
description: |
|
1369
|
+
Sets of elements to identify a name of the identification scheme.
|
1370
|
+
properties:
|
1371
|
+
Cd:
|
1372
|
+
$ref: "#/components/schemas/ExternalAccountIdentification1Code"
|
1373
|
+
Prtry:
|
1374
|
+
$ref: "#/components/schemas/Max35Text"
|
1375
|
+
oneOf:
|
1376
|
+
- required:
|
1377
|
+
- Cd
|
1378
|
+
- required:
|
1379
|
+
- Prtry
|
1380
|
+
example:
|
1381
|
+
Cd: 1111
|
1382
|
+
ActiveCurrencyAndAmount:
|
1383
|
+
title: ActiveCurrencyAndAmount
|
1384
|
+
type: object
|
1385
|
+
description: >
|
1386
|
+
A number of monetary units specified in an active currency where the
|
1387
|
+
unit of currency is explicit and compliant with ISO 4217.
|
1388
|
+
properties:
|
1389
|
+
ActiveCurrencyAndAmount:
|
1390
|
+
$ref: "#/components/schemas/ActiveCurrencyAndAmount_SimpleType"
|
1391
|
+
Ccy:
|
1392
|
+
$ref: "#/components/schemas/ActiveCurrencyCode"
|
1393
|
+
required:
|
1394
|
+
- ActiveCurrencyAndAmount
|
1395
|
+
- Ccy
|
1396
|
+
example:
|
1397
|
+
ActiveCurrencyAndAmount: 123.45
|
1398
|
+
Ccy: USD
|
1399
|
+
ActiveCurrencyAndAmount_SimpleType:
|
1400
|
+
title: ActiveCurrencyAndAmount_SimpleType
|
1401
|
+
type: string
|
1402
|
+
description: |
|
1403
|
+
NOTE: This regex doesn't seem correct given it's xsd definition.
|
1404
|
+
<xs:simpleType name="ActiveCurrencyAndAmount_SimpleType">
|
1405
|
+
<xs:restriction base="xs:decimal">
|
1406
|
+
<xs:fractionDigits value="5"/>
|
1407
|
+
<xs:totalDigits value="18"/>
|
1408
|
+
<xs:minInclusive value="0"/>
|
1409
|
+
</xs:restriction>
|
1410
|
+
</xs:simpleType>
|
1411
|
+
pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$
|
1412
|
+
example: 123.45
|
1413
|
+
ActiveCurrencyCode:
|
1414
|
+
title: ActiveCurrencyCode
|
1415
|
+
type: string
|
1416
|
+
pattern: ^[A-Z]{3,3}$
|
1417
|
+
description: >-
|
1418
|
+
A code allocated to a currency by a Maintenance Agency under an
|
1419
|
+
international identification scheme as described in the latest edition
|
1420
|
+
of the international standard ISO 4217 "Codes for the representation of
|
1421
|
+
currencies and funds".
|
1422
|
+
example: USD
|
1423
|
+
ActiveOrHistoricCurrencyAndAmount:
|
1424
|
+
title: ActiveOrHistoricCurrencyAndAmount
|
1425
|
+
type: object
|
1426
|
+
description: >
|
1427
|
+
A number of monetary units specified in an active or a historic currency
|
1428
|
+
where the unit of currency is explicit and compliant with ISO 4217.
|
1429
|
+
properties:
|
1430
|
+
ActiveOrHistoricCurrencyAndAmount:
|
1431
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount_SimpleType"
|
1432
|
+
Ccy:
|
1433
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
|
1434
|
+
required:
|
1435
|
+
- ActiveOrHistoricCurrencyAndAmount
|
1436
|
+
- Ccy
|
1437
|
+
example:
|
1438
|
+
ActiveOrHistoricCurrencyAndAmount: 123.45
|
1439
|
+
Ccy: USD
|
1440
|
+
ActiveOrHistoricCurrencyAndAmount_SimpleType:
|
1441
|
+
title: ActiveOrHistoricCurrencyAndAmount_SimpleType
|
1442
|
+
type: string
|
1443
|
+
pattern: ^(?=[\d\-\.\,]{1,18}$)([\d\-\,\.]{1,5})?$
|
1444
|
+
example: 123.45
|
1445
|
+
ActiveOrHistoricCurrencyCode:
|
1446
|
+
title: ActiveOrHistoricCurrencyCode
|
1447
|
+
type: string
|
1448
|
+
description: >
|
1449
|
+
A code allocated to a currency by a Maintenance Agency under an
|
1450
|
+
international identification scheme, as described in the latest edition
|
1451
|
+
of the international standard ISO 4217 "Codes for the representation of
|
1452
|
+
currencies and funds".
|
1453
|
+
pattern: ^[A-Z]{3,3}$
|
1454
|
+
example: USD
|
1455
|
+
AddressType2Code:
|
1456
|
+
description: |
|
1457
|
+
AddressType2Code
|
1458
|
+
Specifies the type of address.
|
1459
|
+
enum:
|
1460
|
+
- ADDR
|
1461
|
+
- PBOX
|
1462
|
+
- HOME
|
1463
|
+
- BIZZ
|
1464
|
+
- MLTO
|
1465
|
+
- DLVY
|
1466
|
+
type: string
|
1467
|
+
example: ADDR
|
1468
|
+
AddressType3Choice:
|
1469
|
+
title: AddressType3Choice
|
1470
|
+
type: object
|
1471
|
+
description: |
|
1472
|
+
Choice of formats for the type of address.
|
1473
|
+
properties:
|
1474
|
+
Cd:
|
1475
|
+
$ref: "#/components/schemas/AddressType2Code"
|
1476
|
+
Prtry:
|
1477
|
+
$ref: "#/components/schemas/GenericIdentification30"
|
1478
|
+
oneOf:
|
1479
|
+
- required:
|
1480
|
+
- Cd
|
1481
|
+
- required:
|
1482
|
+
- Prtry
|
1483
|
+
example:
|
1484
|
+
Cd: ADDR
|
1485
|
+
AnyBICDec2014Identifier:
|
1486
|
+
title: AnyBICDec2014Identifier
|
1487
|
+
type: string
|
1488
|
+
description: >
|
1489
|
+
AnyBICDec2014Identifier
|
1490
|
+
|
1491
|
+
Code allocated to a financial or non-financial institution by the
|
1492
|
+
|
1493
|
+
ISO 9362 Registration Authority, as described in ISO 9362: 2014
|
1494
|
+
|
1495
|
+
- "Banking - Banking telecommunication messages - Business identifier
|
1496
|
+
code (BIC)".
|
1497
|
+
pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
|
1498
|
+
example: J5BMVH7D
|
1499
|
+
BICFIDec2014Identifier:
|
1500
|
+
title: BICFIDec2014Identifier
|
1501
|
+
type: string
|
1502
|
+
description: >
|
1503
|
+
Code allocated to a financial institution by the ISO 9362 Registration
|
1504
|
+
|
1505
|
+
|
1506
|
+
Authority as described in ISO 9362: 2014
|
1507
|
+
|
1508
|
+
|
1509
|
+
- "Banking - Banking telecommunication messages - Business identifier
|
1510
|
+
code (BIC)".
|
1511
|
+
pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
|
1512
|
+
example: J5BMVH7D
|
1513
|
+
BaseOneRate:
|
1514
|
+
title: BaseOneRate
|
1515
|
+
type: string
|
1516
|
+
description: |
|
1517
|
+
Rate expressed as a decimal, for example, 0.7 is 7/10 and 70%.
|
1518
|
+
pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$
|
1519
|
+
example: 0.7
|
1520
|
+
BranchAndFinancialInstitutionIdentification6:
|
1521
|
+
title: BranchAndFinancialInstitutionIdentification6
|
1522
|
+
type: object
|
1523
|
+
description: >
|
1524
|
+
Unique and unambiguous identification of a financial institution or a
|
1525
|
+
branch of a financial institution.
|
1526
|
+
properties:
|
1527
|
+
FinInstnId:
|
1528
|
+
$ref: "#/components/schemas/FinancialInstitutionIdentification18"
|
1529
|
+
BrnchId:
|
1530
|
+
$ref: "#/components/schemas/BranchData3"
|
1531
|
+
required:
|
1532
|
+
- FinInstnId
|
1533
|
+
example:
|
1534
|
+
FinInstnId:
|
1535
|
+
BICFI: J5BMVH7D
|
1536
|
+
BrnchId:
|
1537
|
+
Id: 123
|
1538
|
+
Nm: Name
|
1539
|
+
PstlAdr:
|
1540
|
+
AdrTp: ADDR
|
1541
|
+
Dept: Department
|
1542
|
+
SubDept: Sub department
|
1543
|
+
StrtNm: Street name
|
1544
|
+
BldgNb: Building number
|
1545
|
+
PstCd: Post code
|
1546
|
+
TwnNm: Town name
|
1547
|
+
CtrySubDvsn: Country subdivision
|
1548
|
+
Ctry: Country
|
1549
|
+
AdrLine: Address line
|
1550
|
+
BranchAndFinancialInstitutionIdentification8:
|
1551
|
+
title: BranchAndFinancialInstitutionIdentification8
|
1552
|
+
type: object
|
1553
|
+
description: >
|
1554
|
+
Unique and unambiguous identification of a financial institution or a
|
1555
|
+
branch of a financial institution.
|
1556
|
+
properties:
|
1557
|
+
FinInstnId:
|
1558
|
+
$ref: "#/components/schemas/FinancialInstitutionIdentification23"
|
1559
|
+
BrnchId:
|
1560
|
+
$ref: "#/components/schemas/BranchData5"
|
1561
|
+
required:
|
1562
|
+
- FinInstnId
|
1563
|
+
example:
|
1564
|
+
FinInstnId:
|
1565
|
+
BICFI: BUKBGB22
|
1566
|
+
BrnchId:
|
1567
|
+
Id: 12345
|
1568
|
+
Nm: Oxford Street Branch
|
1569
|
+
PstlAdr:
|
1570
|
+
Ctry: GB
|
1571
|
+
AdrLine:
|
1572
|
+
- 1 Oxford Street
|
1573
|
+
- London
|
1574
|
+
- UK
|
1575
|
+
BranchData3:
|
1576
|
+
title: BranchData3
|
1577
|
+
type: object
|
1578
|
+
description: >
|
1579
|
+
Information that locates and identifies a specific branch of a financial
|
1580
|
+
institution.
|
1581
|
+
properties:
|
1582
|
+
Id:
|
1583
|
+
$ref: "#/components/schemas/Max35Text"
|
1584
|
+
LEI:
|
1585
|
+
$ref: "#/components/schemas/LEIIdentifier"
|
1586
|
+
Nm:
|
1587
|
+
$ref: "#/components/schemas/Max140Text"
|
1588
|
+
PstlAdr:
|
1589
|
+
$ref: "#/components/schemas/PostalAddress24"
|
1590
|
+
example:
|
1591
|
+
Id: 123
|
1592
|
+
Nm: Name
|
1593
|
+
PstlAdr:
|
1594
|
+
AdrTp: ADDR
|
1595
|
+
Dept: Department
|
1596
|
+
SubDept: Sub department
|
1597
|
+
StrtNm: Street name
|
1598
|
+
BldgNb: Building number
|
1599
|
+
PstCd: Post code
|
1600
|
+
TwnNm: Town name
|
1601
|
+
CtrySubDvsn: Country subdivision
|
1602
|
+
Ctry: Country
|
1603
|
+
AdrLine: Address line
|
1604
|
+
BranchData5:
|
1605
|
+
title: BranchData5
|
1606
|
+
description: >
|
1607
|
+
Information that locates and identifies a specific branch of a financial
|
1608
|
+
institution.
|
1609
|
+
type: object
|
1610
|
+
properties:
|
1611
|
+
Id:
|
1612
|
+
$ref: "#/components/schemas/Max35Text"
|
1613
|
+
LEI:
|
1614
|
+
$ref: "#/components/schemas/LEIIdentifier"
|
1615
|
+
Nm:
|
1616
|
+
$ref: "#/components/schemas/Max140Text"
|
1617
|
+
PstlAdr:
|
1618
|
+
$ref: "#/components/schemas/PostalAddress27"
|
1619
|
+
example:
|
1620
|
+
Id: 123
|
1621
|
+
Nm: Oxford Street Branch
|
1622
|
+
PstlAdr:
|
1623
|
+
Ctry: GB
|
1624
|
+
AdrLine:
|
1625
|
+
- 1 Oxford Street
|
1626
|
+
- London
|
1627
|
+
- UK
|
1628
|
+
CashAccount40:
|
1629
|
+
title: CashAccount40
|
1630
|
+
type: object
|
1631
|
+
description: |
|
1632
|
+
Provides the details to identify an account.
|
1633
|
+
properties:
|
1634
|
+
Id:
|
1635
|
+
$ref: "#/components/schemas/AccountIdentification4Choice"
|
1636
|
+
Tp:
|
1637
|
+
$ref: "#/components/schemas/CashAccountType2Choice"
|
1638
|
+
Ccy:
|
1639
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyCode"
|
1640
|
+
Nm:
|
1641
|
+
$ref: "#/components/schemas/Max70Text"
|
1642
|
+
Prxy:
|
1643
|
+
$ref: "#/components/schemas/ProxyAccountIdentification1"
|
1644
|
+
example:
|
1645
|
+
Id:
|
1646
|
+
IBAN: BE71096123456769
|
1647
|
+
Tp:
|
1648
|
+
Cd: CACC
|
1649
|
+
Ccy: EUR
|
1650
|
+
Nm: My account
|
1651
|
+
Prxy:
|
1652
|
+
Id: 12345
|
1653
|
+
CashAccountType2Choice:
|
1654
|
+
title: CashAccountType2Choice
|
1655
|
+
description: |
|
1656
|
+
Specifies the nature, or use of the account.
|
1657
|
+
type: object
|
1658
|
+
properties:
|
1659
|
+
Cd:
|
1660
|
+
$ref: "#/components/schemas/ExternalCashAccountType1Code"
|
1661
|
+
Prtry:
|
1662
|
+
$ref: "#/components/schemas/Max35Text"
|
1663
|
+
oneOf:
|
1664
|
+
- required:
|
1665
|
+
- Cd
|
1666
|
+
- required:
|
1667
|
+
- Prtry
|
1668
|
+
example:
|
1669
|
+
Cd: CACC
|
1670
|
+
CategoryPurpose1Choice:
|
1671
|
+
title: CategoryPurpose1Choice
|
1672
|
+
description: >
|
1673
|
+
Contains details about high level purpose of the mandate based on a set
|
1674
|
+
of pre-defined categories.
|
1675
|
+
type: object
|
1676
|
+
properties:
|
1677
|
+
Cd:
|
1678
|
+
$ref: "#/components/schemas/ExternalCategoryPurpose1Code"
|
1679
|
+
Prtry:
|
1680
|
+
$ref: "#/components/schemas/Max35Text"
|
1681
|
+
oneOf:
|
1682
|
+
- required:
|
1683
|
+
- Cd
|
1684
|
+
- required:
|
1685
|
+
- Prtry
|
1686
|
+
example:
|
1687
|
+
Cd: CASH
|
1688
|
+
ChargeBearerType1Code:
|
1689
|
+
title: ChargeBearerType1Code
|
1690
|
+
description: >
|
1691
|
+
Specifies which party(ies) will pay charges due for processing of the
|
1692
|
+
instruction.
|
1693
|
+
|
1694
|
+
DEBT BorneByDebtor All transaction charges are to be borne by the
|
1695
|
+
debtor.
|
1696
|
+
|
1697
|
+
CRED BorneByCreditor All transaction charges are to be borne by the
|
1698
|
+
creditor.
|
1699
|
+
|
1700
|
+
SHAR Shared In a credit transfer context, means that transaction charges
|
1701
|
+
on the sender side are to be borne by the debtor, transaction charges on
|
1702
|
+
the receiver side are to be borne by the creditor. In a direct debit
|
1703
|
+
context, means that transaction charges on the sender side are to be
|
1704
|
+
borne by the creditor, transaction charges on the receiver
|
1705
|
+
|
1706
|
+
SLEV FollowingServiceLevel Charges are to be applied following the rules
|
1707
|
+
agreed in the service level.
|
1708
|
+
type: string
|
1709
|
+
enum:
|
1710
|
+
- DEBT
|
1711
|
+
- CRED
|
1712
|
+
- SHAR
|
1713
|
+
- SLEV
|
1714
|
+
example: DEBT
|
1715
|
+
ChargeType3Choice:
|
1716
|
+
title: ChargeType3Choice
|
1717
|
+
description: ChargeType3Choice Specifies the type of charge.
|
1718
|
+
type: object
|
1719
|
+
properties:
|
1720
|
+
Cd:
|
1721
|
+
$ref: "#/components/schemas/ExternalChargeType1Code"
|
1722
|
+
Prtry:
|
1723
|
+
$ref: "#/components/schemas/GenericIdentification3"
|
1724
|
+
oneOf:
|
1725
|
+
- required:
|
1726
|
+
- Cd
|
1727
|
+
- required:
|
1728
|
+
- Prtry
|
1729
|
+
example:
|
1730
|
+
Cd: CASH
|
1731
|
+
Charges16:
|
1732
|
+
title: Charges16
|
1733
|
+
description: |
|
1734
|
+
NOTE: Unsure on description.
|
1735
|
+
type: object
|
1736
|
+
properties:
|
1737
|
+
Amt:
|
1738
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
1739
|
+
Agt:
|
1740
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
1741
|
+
Tp:
|
1742
|
+
$ref: "#/components/schemas/ChargeType3Choice"
|
1743
|
+
required:
|
1744
|
+
- Amt
|
1745
|
+
- Agt
|
1746
|
+
example:
|
1747
|
+
Amt:
|
1748
|
+
ActiveOrHistoricCurrencyAndAmount: 123.45
|
1749
|
+
Ccy: USD
|
1750
|
+
Agt:
|
1751
|
+
BrnchId:
|
1752
|
+
Id: BRANCHID
|
1753
|
+
FinInstnId:
|
1754
|
+
BICFI: BICFI
|
1755
|
+
Tp:
|
1756
|
+
Cd: SHAR
|
1757
|
+
ClearingChannel2Code:
|
1758
|
+
title: ClearingChannel2Code
|
1759
|
+
description: >
|
1760
|
+
Specifies the clearing channel for the routing of the transaction, as
|
1761
|
+
part of the payment type identification.
|
1762
|
+
|
1763
|
+
RTGS RealTimeGrossSettlementSystem Clearing channel is a real-time gross
|
1764
|
+
settlement system.
|
1765
|
+
|
1766
|
+
RTNS RealTimeNetSettlementSystem Clearing channel is a real-time net
|
1767
|
+
settlement system.
|
1768
|
+
|
1769
|
+
MPNS MassPaymentNetSystem Clearing channel is a mass payment net
|
1770
|
+
settlement system.
|
1771
|
+
|
1772
|
+
BOOK BookTransfer Payment through internal book transfer.
|
1773
|
+
type: string
|
1774
|
+
enum:
|
1775
|
+
- RTGS
|
1776
|
+
- RTNS
|
1777
|
+
- MPNS
|
1778
|
+
- BOOK
|
1779
|
+
example: RTGS
|
1780
|
+
ClearingSystemIdentification2Choice:
|
1781
|
+
title: ClearingSystemIdentification2Choice
|
1782
|
+
description: |
|
1783
|
+
Choice of a clearing system identifier.
|
1784
|
+
type: object
|
1785
|
+
properties:
|
1786
|
+
Cd:
|
1787
|
+
$ref: "#/components/schemas/ExternalClearingSystemIdentification1Code"
|
1788
|
+
Prtry:
|
1789
|
+
$ref: "#/components/schemas/Max35Text"
|
1790
|
+
oneOf:
|
1791
|
+
- required:
|
1792
|
+
- Cd
|
1793
|
+
- required:
|
1794
|
+
- Prtry
|
1795
|
+
example:
|
1796
|
+
Cd: CHQB
|
1797
|
+
ClearingSystemMemberIdentification2:
|
1798
|
+
title: ClearingSystemMemberIdentification2
|
1799
|
+
description: >
|
1800
|
+
Unique identification, as assigned by a clearing system, to
|
1801
|
+
unambiguously identify a member of the clearing system.
|
1802
|
+
type: object
|
1803
|
+
properties:
|
1804
|
+
ClrSysId:
|
1805
|
+
$ref: "#/components/schemas/ClearingSystemIdentification2Choice"
|
1806
|
+
MmbId:
|
1807
|
+
$ref: "#/components/schemas/Max35Text"
|
1808
|
+
required:
|
1809
|
+
- MmbId
|
1810
|
+
example:
|
1811
|
+
ClrSysId:
|
1812
|
+
Cd: CHQB
|
1813
|
+
MmbId: 123456789
|
1814
|
+
Contact13:
|
1815
|
+
title: Contact13
|
1816
|
+
description: |
|
1817
|
+
Specifies the details of the contact person.
|
1818
|
+
type: object
|
1819
|
+
properties:
|
1820
|
+
NmPrfx:
|
1821
|
+
$ref: "#/components/schemas/NamePrefix2Code"
|
1822
|
+
Nm:
|
1823
|
+
$ref: "#/components/schemas/Max140Text"
|
1824
|
+
PhneNb:
|
1825
|
+
$ref: "#/components/schemas/PhoneNumber"
|
1826
|
+
MobNb:
|
1827
|
+
$ref: "#/components/schemas/PhoneNumber"
|
1828
|
+
FaxNb:
|
1829
|
+
$ref: "#/components/schemas/PhoneNumber"
|
1830
|
+
URLAdr:
|
1831
|
+
$ref: "#/components/schemas/Max2048Text"
|
1832
|
+
EmailAdr:
|
1833
|
+
$ref: "#/components/schemas/Max256Text"
|
1834
|
+
EmailPurp:
|
1835
|
+
$ref: "#/components/schemas/Max35Text"
|
1836
|
+
JobTitl:
|
1837
|
+
$ref: "#/components/schemas/Max35Text"
|
1838
|
+
Rspnsblty:
|
1839
|
+
$ref: "#/components/schemas/Max35Text"
|
1840
|
+
Dept:
|
1841
|
+
$ref: "#/components/schemas/Max70Text"
|
1842
|
+
Othr:
|
1843
|
+
$ref: "#/components/schemas/OtherContact1"
|
1844
|
+
PrefrdMtd:
|
1845
|
+
$ref: "#/components/schemas/PreferredContactMethod2Code"
|
1846
|
+
example:
|
1847
|
+
NmPrfx: Mr
|
1848
|
+
Nm: John Doe
|
1849
|
+
PhneNb: +123-123-321
|
1850
|
+
MobNb: +123-123-321
|
1851
|
+
FaxNb: +123-123-321
|
1852
|
+
URLAdr: http://www.example.com
|
1853
|
+
EmailAdr: example@example.com
|
1854
|
+
Contact4:
|
1855
|
+
title: Contact4
|
1856
|
+
description: |
|
1857
|
+
Specifies the details of the contact person.
|
1858
|
+
type: object
|
1859
|
+
properties:
|
1860
|
+
NmPrfx:
|
1861
|
+
$ref: "#/components/schemas/NamePrefix2Code"
|
1862
|
+
Nm:
|
1863
|
+
$ref: "#/components/schemas/Max140Text"
|
1864
|
+
PhneNb:
|
1865
|
+
$ref: "#/components/schemas/PhoneNumber"
|
1866
|
+
MobNb:
|
1867
|
+
$ref: "#/components/schemas/PhoneNumber"
|
1868
|
+
FaxNb:
|
1869
|
+
$ref: "#/components/schemas/PhoneNumber"
|
1870
|
+
EmailAdr:
|
1871
|
+
$ref: "#/components/schemas/Max2048Text"
|
1872
|
+
EmailPurp:
|
1873
|
+
$ref: "#/components/schemas/Max35Text"
|
1874
|
+
JobTitl:
|
1875
|
+
$ref: "#/components/schemas/Max35Text"
|
1876
|
+
Rspnsblty:
|
1877
|
+
$ref: "#/components/schemas/Max35Text"
|
1878
|
+
Dept:
|
1879
|
+
$ref: "#/components/schemas/Max70Text"
|
1880
|
+
Othr:
|
1881
|
+
$ref: "#/components/schemas/OtherContact1"
|
1882
|
+
PrefrdMtd:
|
1883
|
+
$ref: "#/components/schemas/PreferredContactMethod1Code"
|
1884
|
+
example:
|
1885
|
+
NmPrfx: Mr
|
1886
|
+
Nm: John Doe
|
1887
|
+
PhneNb: +123-123-321
|
1888
|
+
MobNb: +123-123-321
|
1889
|
+
FaxNb: +123-123-321
|
1890
|
+
EmailAdr: example@example.com
|
1891
|
+
CountryCode:
|
1892
|
+
title: CountryCode
|
1893
|
+
type: string
|
1894
|
+
pattern: ^[A-Z]{2,2}$
|
1895
|
+
example: US
|
1896
|
+
CreditTransferTransaction67:
|
1897
|
+
title: CreditTransferTransaction67
|
1898
|
+
description: >
|
1899
|
+
Provides further details specific to the individual transaction(s)
|
1900
|
+
included in the message.
|
1901
|
+
type: object
|
1902
|
+
properties:
|
1903
|
+
PmtId:
|
1904
|
+
$ref: "#/components/schemas/PaymentIdentification13"
|
1905
|
+
PmtTpInf:
|
1906
|
+
$ref: "#/components/schemas/PaymentTypeInformation28"
|
1907
|
+
IntrBkSttlmAmt:
|
1908
|
+
$ref: "#/components/schemas/ActiveCurrencyAndAmount"
|
1909
|
+
InstdAmt:
|
1910
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
1911
|
+
XchgRate:
|
1912
|
+
$ref: "#/components/schemas/BaseOneRate"
|
1913
|
+
ChrgBr:
|
1914
|
+
$ref: "#/components/schemas/ChargeBearerType1Code"
|
1915
|
+
ChrgsInf:
|
1916
|
+
$ref: "#/components/schemas/Charges16"
|
1917
|
+
Dbtr:
|
1918
|
+
$ref: "#/components/schemas/PartyIdentification272"
|
1919
|
+
DbtrAcct:
|
1920
|
+
$ref: "#/components/schemas/CashAccount40"
|
1921
|
+
DbtrAgt:
|
1922
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
1923
|
+
CdtrAgt:
|
1924
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
1925
|
+
Cdtr:
|
1926
|
+
$ref: "#/components/schemas/PartyIdentification272"
|
1927
|
+
CdtrAcct:
|
1928
|
+
$ref: "#/components/schemas/CashAccount40"
|
1929
|
+
InstrForCdtrAgt:
|
1930
|
+
$ref: "#/components/schemas/InstructionForCreditorAgent3"
|
1931
|
+
InstrForNxtAgt:
|
1932
|
+
$ref: "#/components/schemas/InstructionForNextAgent1"
|
1933
|
+
Purp:
|
1934
|
+
$ref: "#/components/schemas/Purpose2Choice"
|
1935
|
+
RgltryRptg:
|
1936
|
+
$ref: "#/components/schemas/RegulatoryReporting3"
|
1937
|
+
Tax:
|
1938
|
+
$ref: "#/components/schemas/TaxData1"
|
1939
|
+
VrfctnOfTerms:
|
1940
|
+
$ref: "#/components/schemas/CryptographicLockChoice"
|
1941
|
+
required:
|
1942
|
+
- PmtId
|
1943
|
+
- IntrBkSttlmAmt
|
1944
|
+
- ChrgBr
|
1945
|
+
- Dbtr
|
1946
|
+
- DbtrAgt
|
1947
|
+
- CdtrAgt
|
1948
|
+
- Cdtr
|
1949
|
+
example:
|
1950
|
+
PmtId:
|
1951
|
+
InstrId: INSTRID
|
1952
|
+
EndToEndId: ENDTOENDID
|
1953
|
+
PmtTpInf:
|
1954
|
+
LclInstrm:
|
1955
|
+
Cd: CHQB
|
1956
|
+
Prtry: PROPRIETARY
|
1957
|
+
SeqTp: SEQTP
|
1958
|
+
IntrBkSttlmAmt:
|
1959
|
+
ActiveCurrencyAndAmount: 123.45
|
1960
|
+
Ccy: USD
|
1961
|
+
InstdAmt:
|
1962
|
+
ActiveOrHistoricCurrencyAndAmount: 123.45
|
1963
|
+
Ccy: USD
|
1964
|
+
XchgRate: 123.45
|
1965
|
+
ChrgBr: SHAR
|
1966
|
+
ChrgsInf:
|
1967
|
+
Amt:
|
1968
|
+
ActiveOrHistoricCurrencyAndAmount: 123.45
|
1969
|
+
Ccy: USD
|
1970
|
+
Agt:
|
1971
|
+
BrnchId:
|
1972
|
+
Id: BRANCHID
|
1973
|
+
FinInstnId:
|
1974
|
+
BICFI: BICFI
|
1975
|
+
Tp:
|
1976
|
+
Cd: SHAR
|
1977
|
+
Dbtr:
|
1978
|
+
Nm: NAME
|
1979
|
+
PstlAdr:
|
1980
|
+
AdrTp: ADDR
|
1981
|
+
BldgNb: BLDGNB
|
1982
|
+
Ctry: CTRY
|
1983
|
+
TwnNm: TWNNM
|
1984
|
+
PstCd: PSTCD
|
1985
|
+
StrtNm: STRTNM
|
1986
|
+
DbtrAcct:
|
1987
|
+
Id:
|
1988
|
+
IBAN: IBAN
|
1989
|
+
DbtrAgt:
|
1990
|
+
BrnchId:
|
1991
|
+
Id: BRANCHID
|
1992
|
+
FinInstnId:
|
1993
|
+
BICFI: BICFI
|
1994
|
+
CdtrAgt:
|
1995
|
+
BrnchId:
|
1996
|
+
Id: BRANCHID
|
1997
|
+
FinInstnId:
|
1998
|
+
BICFI: BICFI
|
1999
|
+
Cdtr:
|
2000
|
+
Nm: NAME
|
2001
|
+
PstlAdr:
|
2002
|
+
AdrTp: ADDR
|
2003
|
+
BldgNb: BLDGNB
|
2004
|
+
Ctry: CTRY
|
2005
|
+
TwnNm: TWNNM
|
2006
|
+
PstCd: PSTCD
|
2007
|
+
StrtNm: STRTNM
|
2008
|
+
CdtrAcct:
|
2009
|
+
Id:
|
2010
|
+
IBAN: IBAN
|
2011
|
+
InstrForCdtrAgt:
|
2012
|
+
Cd: CODE
|
2013
|
+
InstrForNxtAgt:
|
2014
|
+
Cd: CODE
|
2015
|
+
Purp:
|
2016
|
+
Cd: CASH
|
2017
|
+
RgltryRptg:
|
2018
|
+
Dbtr: true
|
2019
|
+
Cdtr: true
|
2020
|
+
Tax: Cdtr
|
2021
|
+
CreditTransferTransaction68:
|
2022
|
+
title: CreditTransferTransaction68
|
2023
|
+
description: >
|
2024
|
+
Provides further details specific to the individual transaction(s)
|
2025
|
+
included in the message.
|
2026
|
+
type: object
|
2027
|
+
properties:
|
2028
|
+
PmtId:
|
2029
|
+
$ref: "#/components/schemas/PaymentIdentification13"
|
2030
|
+
PmtTpInf:
|
2031
|
+
$ref: "#/components/schemas/PaymentTypeInformation28"
|
2032
|
+
IntrBkSttlmAmt:
|
2033
|
+
$ref: "#/components/schemas/ActiveCurrencyAndAmount"
|
2034
|
+
Dbtr:
|
2035
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
2036
|
+
DbtrAcct:
|
2037
|
+
$ref: "#/components/schemas/CashAccount40"
|
2038
|
+
DbtrAgt:
|
2039
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
2040
|
+
CdtrAgt:
|
2041
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
2042
|
+
Cdtr:
|
2043
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification8"
|
2044
|
+
CdtrAcct:
|
2045
|
+
$ref: "#/components/schemas/CashAccount40"
|
2046
|
+
InstrForCdtrAgt:
|
2047
|
+
$ref: "#/components/schemas/InstructionForCreditorAgent3"
|
2048
|
+
Purp:
|
2049
|
+
$ref: "#/components/schemas/Purpose2Choice"
|
2050
|
+
VrfctnOfTerms:
|
2051
|
+
$ref: "#/components/schemas/CryptographicLockChoice"
|
2052
|
+
required:
|
2053
|
+
- PmtId
|
2054
|
+
- IntrBkSttlmAmt
|
2055
|
+
- Dbtr
|
2056
|
+
- Cdtr
|
2057
|
+
example:
|
2058
|
+
PmtId:
|
2059
|
+
InstrId: INSTRID
|
2060
|
+
EndToEndId: ENDTOENDID
|
2061
|
+
PmtTpInf:
|
2062
|
+
LclInstrm:
|
2063
|
+
Cd: CHQB
|
2064
|
+
Prtry: PROPRIETARY
|
2065
|
+
IntrBkSttlmAmt:
|
2066
|
+
Amount: 123.45
|
2067
|
+
Ccy: EUR
|
2068
|
+
Dbtr:
|
2069
|
+
Nm: Debtor Name
|
2070
|
+
DbtrAcct:
|
2071
|
+
Id:
|
2072
|
+
IBAN: IBAN
|
2073
|
+
DbtrAgt:
|
2074
|
+
FinInstnId:
|
2075
|
+
BICFI: BICFI
|
2076
|
+
CdtrAgt:
|
2077
|
+
FinInstnId:
|
2078
|
+
BICFI: BICFI
|
2079
|
+
Cdtr:
|
2080
|
+
Nm: Creditor Name
|
2081
|
+
CdtrAcct:
|
2082
|
+
Id:
|
2083
|
+
IBAN: IBAN
|
2084
|
+
InstrForCdtrAgt:
|
2085
|
+
Cd: INSTRUCTION
|
2086
|
+
Purp:
|
2087
|
+
Cd: CHAR
|
2088
|
+
VrfctnOfTerms:
|
2089
|
+
Cntt: CONTENT
|
2090
|
+
CnttTp: PROPRIETARY
|
2091
|
+
CryptographicLockChoice:
|
2092
|
+
title: CryptographicLockChoice
|
2093
|
+
description: |
|
2094
|
+
NOTE: Unsure on description.
|
2095
|
+
type: object
|
2096
|
+
properties:
|
2097
|
+
IlpV4PrepPacket:
|
2098
|
+
$ref: "#/components/schemas/hexBinary"
|
2099
|
+
Sh256Sgntr:
|
2100
|
+
$ref: "#/components/schemas/Exact32HexBinaryText"
|
2101
|
+
oneOf:
|
2102
|
+
- required:
|
2103
|
+
- IlpV4PrepPacket
|
2104
|
+
- required:
|
2105
|
+
- Sh256Sgntr
|
2106
|
+
example:
|
2107
|
+
IlpV4PrepPacket: 1234567890ABCDEF
|
2108
|
+
DateAndPlaceOfBirth1:
|
2109
|
+
title: DateAndPlaceOfBirth1
|
2110
|
+
description: |
|
2111
|
+
Details about date and place of birth of a person.
|
2112
|
+
type: object
|
2113
|
+
properties:
|
2114
|
+
BirthDt:
|
2115
|
+
$ref: "#/components/schemas/ISODate"
|
2116
|
+
PrvcOfBirth:
|
2117
|
+
$ref: "#/components/schemas/Max35Text"
|
2118
|
+
CityOfBirth:
|
2119
|
+
$ref: "#/components/schemas/Max35Text"
|
2120
|
+
CtryOfBirth:
|
2121
|
+
$ref: "#/components/schemas/CountryCode"
|
2122
|
+
required:
|
2123
|
+
- BirthDt
|
2124
|
+
- CityOfBirth
|
2125
|
+
- CtryOfBirth
|
2126
|
+
example:
|
2127
|
+
BirthDt: "1970-01-01"
|
2128
|
+
PrvcOfBirth: "ON"
|
2129
|
+
CityOfBirth: Ottawa
|
2130
|
+
CtryOfBirth: CA
|
2131
|
+
DatePeriod2:
|
2132
|
+
title: DatePeriod2
|
2133
|
+
description: |
|
2134
|
+
Range of time defined by a start date and an end date.
|
2135
|
+
type: object
|
2136
|
+
properties:
|
2137
|
+
FrDt:
|
2138
|
+
$ref: "#/components/schemas/ISODate"
|
2139
|
+
ToDt:
|
2140
|
+
$ref: "#/components/schemas/ISODate"
|
2141
|
+
required:
|
2142
|
+
- FrDt
|
2143
|
+
- ToDt
|
2144
|
+
example:
|
2145
|
+
FrDt: "2020-01-01"
|
2146
|
+
ToDt: "2020-12-31"
|
2147
|
+
ErrorCode:
|
2148
|
+
title: ErrorCode
|
2149
|
+
type: string
|
2150
|
+
pattern: ^[1-9]\d{3}$
|
2151
|
+
description: >-
|
2152
|
+
The API data type ErrorCode is a JSON String of four characters,
|
2153
|
+
consisting of digits only. Negative numbers are not allowed. A leading
|
2154
|
+
zero is not allowed. Each error code in the API is a four-digit number,
|
2155
|
+
for example, 1234, where the first number (1 in the example) represents
|
2156
|
+
the high-level error category, the second number (2 in the example)
|
2157
|
+
represents the low-level error category, and the last two numbers (34 in
|
2158
|
+
the example) represent the specific error.
|
2159
|
+
example: "5100"
|
2160
|
+
ErrorDescription:
|
2161
|
+
title: ErrorDescription
|
2162
|
+
type: string
|
2163
|
+
minLength: 1
|
2164
|
+
maxLength: 128
|
2165
|
+
description: Error description string.
|
2166
|
+
ErrorInformation:
|
2167
|
+
title: ErrorInformation
|
2168
|
+
type: object
|
2169
|
+
description: Data model for the complex type ErrorInformation.
|
2170
|
+
properties:
|
2171
|
+
errorCode:
|
2172
|
+
$ref: "#/components/schemas/ErrorCode"
|
2173
|
+
errorDescription:
|
2174
|
+
$ref: "#/components/schemas/ErrorDescription"
|
2175
|
+
extensionList:
|
2176
|
+
$ref: "#/components/schemas/ExtensionList"
|
2177
|
+
required:
|
2178
|
+
- errorCode
|
2179
|
+
- errorDescription
|
2180
|
+
ErrorInformationResponse:
|
2181
|
+
title: ErrorInformationResponse
|
2182
|
+
type: object
|
2183
|
+
description: >
|
2184
|
+
Data model for the complex type object that contains an optional element
|
2185
|
+
ErrorInformation used along with 4xx and 5xx responses.
|
2186
|
+
properties:
|
2187
|
+
errorInformation:
|
2188
|
+
$ref: "#/components/schemas/ErrorInformation"
|
2189
|
+
Exact32HexBinaryText:
|
2190
|
+
title: Exact32HexBinaryText
|
2191
|
+
description: |
|
2192
|
+
Specifies a hexadecimal string with a length of 32 characters.
|
2193
|
+
type: string
|
2194
|
+
pattern: ^([0-9A-F][0-9A-F]){32}$
|
2195
|
+
example: 1234567890ABCDEF1234567890ABCDEF
|
2196
|
+
Exact4AlphaNumericText:
|
2197
|
+
title: Exact4AlphaNumericText
|
2198
|
+
description: |
|
2199
|
+
Specifies an alphanumeric string with a length of 4 characters.
|
2200
|
+
type: string
|
2201
|
+
pattern: ^[a-zA-Z0-9]{4}$
|
2202
|
+
example: 1234
|
2203
|
+
Execute_FIToFICustomerCreditTransferV13:
|
2204
|
+
title: Execute_FIToFICustomerCreditTransferV13
|
2205
|
+
type: object
|
2206
|
+
properties:
|
2207
|
+
GrpHdr:
|
2208
|
+
$ref: "#/components/schemas/GroupHeader129"
|
2209
|
+
CdtTrfTxInf:
|
2210
|
+
$ref: "#/components/schemas/CreditTransferTransaction67"
|
2211
|
+
required:
|
2212
|
+
- GrpHdr
|
2213
|
+
- CdtTrfTxInf
|
2214
|
+
example:
|
2215
|
+
GrpHdr:
|
2216
|
+
MsgId: 123456789
|
2217
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
2218
|
+
NbOfTxs: 1
|
2219
|
+
CtrlSum: 100
|
2220
|
+
InitgPty:
|
2221
|
+
Nm: Initiating Party Name
|
2222
|
+
Id:
|
2223
|
+
OrgId:
|
2224
|
+
Othr:
|
2225
|
+
- Id: 123456789
|
2226
|
+
SchmeNm:
|
2227
|
+
Cd: 91
|
2228
|
+
FwdgAgt:
|
2229
|
+
FinInstnId:
|
2230
|
+
BICFI: BBBBBBBB
|
2231
|
+
CdtTrfTxInf:
|
2232
|
+
PmtId:
|
2233
|
+
InstrId: 123456789
|
2234
|
+
EndToEndId: 123456789
|
2235
|
+
PmtTpInf:
|
2236
|
+
InstrPrty: NORM
|
2237
|
+
CtgyPurp:
|
2238
|
+
Cd: SUPP
|
2239
|
+
InstrForCdtrAgt:
|
2240
|
+
FinInstnId:
|
2241
|
+
BICFI: AAAAAAAA
|
2242
|
+
CdtrAgt:
|
2243
|
+
FinInstnId:
|
2244
|
+
BICFI: AAAAAAAA
|
2245
|
+
Cdtr:
|
2246
|
+
Nm: Creditor Name
|
2247
|
+
PstlAdr:
|
2248
|
+
AdrLine:
|
2249
|
+
- Creditor Address Line 1
|
2250
|
+
- Creditor Address Line 2
|
2251
|
+
- Creditor Address Line 3
|
2252
|
+
- Creditor Address Line 4
|
2253
|
+
- Creditor Address Line 5
|
2254
|
+
Id:
|
2255
|
+
OrgId:
|
2256
|
+
Othr:
|
2257
|
+
- Id: 123456789
|
2258
|
+
SchmeNm:
|
2259
|
+
Cd: 91
|
2260
|
+
CdtrAcct:
|
2261
|
+
Id:
|
2262
|
+
IBAN: DE87123456781234567890
|
2263
|
+
RmtInf:
|
2264
|
+
Ustrd: Remittance Information
|
2265
|
+
Extension:
|
2266
|
+
title: Extension
|
2267
|
+
type: object
|
2268
|
+
description: Data model for the complex type Extension.
|
2269
|
+
properties:
|
2270
|
+
key:
|
2271
|
+
$ref: "#/components/schemas/ExtensionKey"
|
2272
|
+
value:
|
2273
|
+
$ref: "#/components/schemas/ExtensionValue"
|
2274
|
+
required:
|
2275
|
+
- key
|
2276
|
+
- value
|
2277
|
+
ExtensionKey:
|
2278
|
+
title: ExtensionKey
|
2279
|
+
type: string
|
2280
|
+
minLength: 1
|
2281
|
+
maxLength: 32
|
2282
|
+
description: Extension key.
|
2283
|
+
ExtensionList:
|
2284
|
+
title: ExtensionList
|
2285
|
+
type: object
|
2286
|
+
description: >
|
2287
|
+
Data model for the complex type ExtensionList. An optional list of
|
2288
|
+
extensions, specific to deployment.
|
2289
|
+
properties:
|
2290
|
+
extension:
|
2291
|
+
type: array
|
2292
|
+
items:
|
2293
|
+
$ref: "#/components/schemas/Extension"
|
2294
|
+
minItems: 1
|
2295
|
+
maxItems: 16
|
2296
|
+
description: Number of Extension elements.
|
2297
|
+
required:
|
2298
|
+
- extension
|
2299
|
+
ExtensionValue:
|
2300
|
+
title: ExtensionValue
|
2301
|
+
type: string
|
2302
|
+
minLength: 1
|
2303
|
+
maxLength: 128
|
2304
|
+
description: Extension value.
|
2305
|
+
ExternalAccountIdentification1Code:
|
2306
|
+
title: ExternalAccountIdentification1Code
|
2307
|
+
description: >
|
2308
|
+
Specifies the external account identification scheme name code in the
|
2309
|
+
format of character string with a maximum length of 4 characters.
|
2310
|
+
type: string
|
2311
|
+
minLength: 1
|
2312
|
+
maxLength: 4
|
2313
|
+
example: 1234
|
2314
|
+
ExternalCashAccountType1Code:
|
2315
|
+
title: ExternalCashAccountType1Code
|
2316
|
+
description: >
|
2317
|
+
Specifies the nature, or use, of the cash account in the format of
|
2318
|
+
character string with a maximum length of 4 characters.
|
2319
|
+
type: string
|
2320
|
+
minLength: 1
|
2321
|
+
maxLength: 4
|
2322
|
+
example: 1234
|
2323
|
+
ExternalCategoryPurpose1Code:
|
2324
|
+
description: >
|
2325
|
+
Specifies the category purpose, as published in an external category
|
2326
|
+
purpose code list.
|
2327
|
+
|
2328
|
+
External code sets can be downloaded from www.iso20022.org.
|
2329
|
+
maxLength: 4
|
2330
|
+
minLength: 1
|
2331
|
+
type: string
|
2332
|
+
example: 1234
|
2333
|
+
ExternalChargeType1Code:
|
2334
|
+
title: ExternalChargeType1Code
|
2335
|
+
type: string
|
2336
|
+
minLength: 1
|
2337
|
+
maxLength: 4
|
2338
|
+
example: 1234
|
2339
|
+
ExternalClearingSystemIdentification1Code:
|
2340
|
+
title: ExternalClearingSystemIdentification1Code
|
2341
|
+
type: string
|
2342
|
+
minLength: 1
|
2343
|
+
maxLength: 5
|
2344
|
+
example: 12345
|
2345
|
+
ExternalCreditorAgentInstruction1Code:
|
2346
|
+
title: ExternalCreditorAgentInstruction1Code
|
2347
|
+
type: string
|
2348
|
+
minLength: 1
|
2349
|
+
maxLength: 4
|
2350
|
+
example: 1234
|
2351
|
+
ExternalFinancialInstitutionIdentification1Code:
|
2352
|
+
title: ExternalFinancialInstitutionIdentification1Code
|
2353
|
+
type: string
|
2354
|
+
minLength: 1
|
2355
|
+
maxLength: 4
|
2356
|
+
example: 1234
|
2357
|
+
ExternalLocalInstrument1Code:
|
2358
|
+
title: ExternalLocalInstrument1Code
|
2359
|
+
type: string
|
2360
|
+
minLength: 1
|
2361
|
+
maxLength: 35
|
2362
|
+
example: 12345
|
2363
|
+
ExternalOrganisationIdentification1Code:
|
2364
|
+
title: ExternalOrganisationIdentification1Code
|
2365
|
+
type: string
|
2366
|
+
minLength: 1
|
2367
|
+
maxLength: 4
|
2368
|
+
example: 1234
|
2369
|
+
ExternalPaymentTransactionStatus1Code:
|
2370
|
+
title: ExternalPaymentTransactionStatus1Code
|
2371
|
+
type: string
|
2372
|
+
minLength: 1
|
2373
|
+
maxLength: 4
|
2374
|
+
example: 1234
|
2375
|
+
ExternalPersonIdentification1Code:
|
2376
|
+
title: ExternalPersonIdentification1Code
|
2377
|
+
type: string
|
2378
|
+
minLength: 1
|
2379
|
+
maxLength: 4
|
2380
|
+
example: 1234
|
2381
|
+
ExternalProxyAccountType1Code:
|
2382
|
+
title: ExternalProxyAccountType1Code
|
2383
|
+
type: string
|
2384
|
+
minLength: 1
|
2385
|
+
maxLength: 4
|
2386
|
+
example: 1234
|
2387
|
+
ExternalPurpose1Code:
|
2388
|
+
title: ExternalPurpose1Code
|
2389
|
+
type: string
|
2390
|
+
minLength: 1
|
2391
|
+
maxLength: 4
|
2392
|
+
example: 1234
|
2393
|
+
ExternalServiceLevel1Code:
|
2394
|
+
title: ExternalServiceLevel1Code
|
2395
|
+
type: string
|
2396
|
+
minLength: 1
|
2397
|
+
maxLength: 4
|
2398
|
+
example: 1234
|
2399
|
+
ExternalStatusReason1Code:
|
2400
|
+
title: ExternalStatusReason1Code
|
2401
|
+
type: string
|
2402
|
+
minLength: 1
|
2403
|
+
maxLength: 4
|
2404
|
+
example: 1234
|
2405
|
+
ExternalVerificationReason1Code:
|
2406
|
+
title: ExternalVerificationReason1Code
|
2407
|
+
type: string
|
2408
|
+
minLength: 1
|
2409
|
+
maxLength: 4
|
2410
|
+
example: 1234
|
2411
|
+
FinancialIdentificationSchemeName1Choice:
|
2412
|
+
title: FinancialIdentificationSchemeName1Choice
|
2413
|
+
type: object
|
2414
|
+
properties:
|
2415
|
+
Cd:
|
2416
|
+
$ref: "#/components/schemas/ExternalFinancialInstitutionIdentification1Code"
|
2417
|
+
Prtry:
|
2418
|
+
$ref: "#/components/schemas/Max35Text"
|
2419
|
+
oneOf:
|
2420
|
+
- required:
|
2421
|
+
- Cd
|
2422
|
+
- required:
|
2423
|
+
- Prtry
|
2424
|
+
example:
|
2425
|
+
Cd: BIC
|
2426
|
+
FinancialInstitutionIdentification18:
|
2427
|
+
title: FinancialInstitutionIdentification18
|
2428
|
+
type: object
|
2429
|
+
properties:
|
2430
|
+
BICFI:
|
2431
|
+
$ref: "#/components/schemas/BICFIDec2014Identifier"
|
2432
|
+
ClrSysMmbId:
|
2433
|
+
$ref: "#/components/schemas/ClearingSystemMemberIdentification2"
|
2434
|
+
LEI:
|
2435
|
+
$ref: "#/components/schemas/LEIIdentifier"
|
2436
|
+
Nm:
|
2437
|
+
$ref: "#/components/schemas/Max140Text"
|
2438
|
+
PstlAdr:
|
2439
|
+
$ref: "#/components/schemas/PostalAddress24"
|
2440
|
+
Othr:
|
2441
|
+
$ref: "#/components/schemas/GenericFinancialIdentification1"
|
2442
|
+
example:
|
2443
|
+
BICFI: BUKBGB22
|
2444
|
+
Nm: Barclays Bank Plc
|
2445
|
+
PstlAdr:
|
2446
|
+
Ctry: GB
|
2447
|
+
AdrLine:
|
2448
|
+
- 1 Churchill Place
|
2449
|
+
- London
|
2450
|
+
- UK
|
2451
|
+
FinancialInstitutionIdentification23:
|
2452
|
+
title: FinancialInstitutionIdentification23
|
2453
|
+
type: object
|
2454
|
+
properties:
|
2455
|
+
BICFI:
|
2456
|
+
$ref: "#/components/schemas/BICFIDec2014Identifier"
|
2457
|
+
ClrSysMmbId:
|
2458
|
+
$ref: "#/components/schemas/ClearingSystemMemberIdentification2"
|
2459
|
+
LEI:
|
2460
|
+
$ref: "#/components/schemas/LEIIdentifier"
|
2461
|
+
Nm:
|
2462
|
+
$ref: "#/components/schemas/Max140Text"
|
2463
|
+
PstlAdr:
|
2464
|
+
$ref: "#/components/schemas/PostalAddress27"
|
2465
|
+
Othr:
|
2466
|
+
$ref: "#/components/schemas/GenericFinancialIdentification1"
|
2467
|
+
example:
|
2468
|
+
BICFI: BUKBGB22
|
2469
|
+
Nm: Barclays Bank Plc
|
2470
|
+
PstlAdr:
|
2471
|
+
Ctry: GB
|
2472
|
+
AdrLine:
|
2473
|
+
- 1 Churchill Place
|
2474
|
+
- London
|
2475
|
+
- UK
|
2476
|
+
FxRequest_FICreditTransferProposal:
|
2477
|
+
title: FxRequest_FICreditTransferProposal
|
2478
|
+
type: object
|
2479
|
+
properties:
|
2480
|
+
GrpHdr:
|
2481
|
+
$ref: "#/components/schemas/GroupHeader113"
|
2482
|
+
required:
|
2483
|
+
- GrpHdr
|
2484
|
+
example:
|
2485
|
+
GrpHdr:
|
2486
|
+
MsgId: 123456789
|
2487
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
2488
|
+
NbOfTxs: 1
|
2489
|
+
CtrlSum: 100
|
2490
|
+
InitgPty:
|
2491
|
+
Nm: Initiating Party Name
|
2492
|
+
Id:
|
2493
|
+
OrgId:
|
2494
|
+
Othr:
|
2495
|
+
- Id: 123456789
|
2496
|
+
SchmeNm:
|
2497
|
+
Cd: BIC
|
2498
|
+
FwdgAgt:
|
2499
|
+
FinInstnId:
|
2500
|
+
BICFI: BICFID0
|
2501
|
+
Dbtr:
|
2502
|
+
Nm: Debtor Name
|
2503
|
+
PstlAdr:
|
2504
|
+
AdrLine:
|
2505
|
+
- Debtor Address Line 1
|
2506
|
+
- Debtor Address Line 2
|
2507
|
+
Id:
|
2508
|
+
OrgId:
|
2509
|
+
Othr:
|
2510
|
+
- Id: 123456789
|
2511
|
+
SchmeNm:
|
2512
|
+
Cd: BIC
|
2513
|
+
DbtrAcct:
|
2514
|
+
Id:
|
2515
|
+
IBAN: BE71096123456769
|
2516
|
+
DbtrAgt:
|
2517
|
+
FinInstnId:
|
2518
|
+
BICFI: BICFID0
|
2519
|
+
Cdtr:
|
2520
|
+
Nm: Creditor Name
|
2521
|
+
PstlAdr:
|
2522
|
+
AdrLine:
|
2523
|
+
- Creditor Address Line 1
|
2524
|
+
- Creditor Address Line 2
|
2525
|
+
Id:
|
2526
|
+
OrgId:
|
2527
|
+
Othr:
|
2528
|
+
- Id: 123456789
|
2529
|
+
SchmeNm:
|
2530
|
+
Cd: BIC
|
2531
|
+
CdtrAcct:
|
2532
|
+
Id:
|
2533
|
+
IBAN: BE71096123456769
|
2534
|
+
CdtrAgt:
|
2535
|
+
FinInstnId:
|
2536
|
+
BICFI: BICFID0
|
2537
|
+
CdtTrfTxInf:
|
2538
|
+
- PmtId:
|
2539
|
+
InstrId: 123456789
|
2540
|
+
EndToEndId: 123456789
|
2541
|
+
Amt:
|
2542
|
+
InstdAmt:
|
2543
|
+
Ccy: EUR
|
2544
|
+
Amt: 100
|
2545
|
+
CdtrAgt:
|
2546
|
+
FinInstnId:
|
2547
|
+
BICFI: BICFID0
|
2548
|
+
Cdtr:
|
2549
|
+
Nm: Creditor Name
|
2550
|
+
PstlAdr:
|
2551
|
+
AdrLine:
|
2552
|
+
- Creditor Address Line 1
|
2553
|
+
- Creditor Address Line 2
|
2554
|
+
Id:
|
2555
|
+
OrgId:
|
2556
|
+
Othr:
|
2557
|
+
- Id: 123456789
|
2558
|
+
SchmeNm:
|
2559
|
+
Cd: BIC
|
2560
|
+
FxResponse_FICreditTransferConfirmation:
|
2561
|
+
title: FxResponse_FICreditTransferConfirmation
|
2562
|
+
type: object
|
2563
|
+
properties:
|
2564
|
+
GrpHdr:
|
2565
|
+
$ref: "#/components/schemas/GroupHeader113"
|
2566
|
+
CdtTrfTxInf:
|
2567
|
+
$ref: "#/components/schemas/CreditTransferTransaction68"
|
2568
|
+
required:
|
2569
|
+
- GrpHdr
|
2570
|
+
- CdtTrfTxInf
|
2571
|
+
example:
|
2572
|
+
GrpHdr:
|
2573
|
+
MsgId: 20191122-123456
|
2574
|
+
CreDtTm: "2019-11-22T12:34:56"
|
2575
|
+
NbOfTxs: 1
|
2576
|
+
CtrlSum: 100
|
2577
|
+
InitgPty:
|
2578
|
+
Nm: Initiating Party Name
|
2579
|
+
MsgRcpt:
|
2580
|
+
Nm: Message Recipient Name
|
2581
|
+
CdtTrfTxInf:
|
2582
|
+
PmtId:
|
2583
|
+
InstrId: 20191122-123456
|
2584
|
+
EndToEndId: 20191122-123456
|
2585
|
+
PmtTpInf:
|
2586
|
+
InstrPrty: NORM
|
2587
|
+
CtgyPurp: SUPP
|
2588
|
+
IntrBkSttlmAmt:
|
2589
|
+
Amt: 100
|
2590
|
+
Ccy: EUR
|
2591
|
+
ChrgBr: SLEV
|
2592
|
+
Cdtr:
|
2593
|
+
Nm: Creditor Name
|
2594
|
+
CdtrAcct:
|
2595
|
+
Id:
|
2596
|
+
IBAN: BE71096123456769
|
2597
|
+
Tp:
|
2598
|
+
Cd: CACC
|
2599
|
+
Ccy: EUR
|
2600
|
+
Nm: My account
|
2601
|
+
CdtrAgt:
|
2602
|
+
FinInstnId:
|
2603
|
+
BICFI: BNBABEBB
|
2604
|
+
CdtrAgtAcct:
|
2605
|
+
Id:
|
2606
|
+
IBAN: BE71096123456769
|
2607
|
+
Tp:
|
2608
|
+
Cd: CACC
|
2609
|
+
Ccy: EUR
|
2610
|
+
Nm: My account
|
2611
|
+
Dbtr:
|
2612
|
+
Nm: Debtor Name
|
2613
|
+
DbtrAcct:
|
2614
|
+
Id:
|
2615
|
+
IBAN: BE71096123456769
|
2616
|
+
Tp:
|
2617
|
+
Cd: CACC
|
2618
|
+
Ccy: EUR
|
2619
|
+
Nm: My account
|
2620
|
+
DbtrAgt:
|
2621
|
+
FinInstnId:
|
2622
|
+
BICFI: BNBABEBB
|
2623
|
+
DbtrAgtAcct:
|
2624
|
+
Id:
|
2625
|
+
IBAN: BE71096123456769
|
2626
|
+
Tp:
|
2627
|
+
Cd: CACC
|
2628
|
+
Ccy: EUR
|
2629
|
+
Nm: My account
|
2630
|
+
RmtInf:
|
2631
|
+
Ustrd: Remittance Information
|
2632
|
+
RgltryRptg:
|
2633
|
+
Dbtr:
|
2634
|
+
Nm: Debtor Name
|
2635
|
+
DbtrAcct:
|
2636
|
+
Id:
|
2637
|
+
IBAN: BE71096123456769
|
2638
|
+
Tp:
|
2639
|
+
Cd: CACC
|
2640
|
+
Ccy: EUR
|
2641
|
+
Nm: My account
|
2642
|
+
Fxecute_FinancialInstitutionCreditTransferV12:
|
2643
|
+
title: Fxecute_FinancialInstitutionCreditTransferV12
|
2644
|
+
type: object
|
2645
|
+
properties:
|
2646
|
+
GrpHdr:
|
2647
|
+
$ref: "#/components/schemas/GroupHeader129"
|
2648
|
+
CdtTrfTxInf:
|
2649
|
+
$ref: "#/components/schemas/CreditTransferTransaction68"
|
2650
|
+
required:
|
2651
|
+
- GrpHdr
|
2652
|
+
- CdtTrfTxInf
|
2653
|
+
example:
|
2654
|
+
GrpHdr:
|
2655
|
+
MsgId: 20191113001
|
2656
|
+
CreDtTm: "2019-11-13T10:00:00"
|
2657
|
+
NbOfTxs: 1
|
2658
|
+
CtrlSum: 1000
|
2659
|
+
InitgPty:
|
2660
|
+
Nm: Initiating Party Name
|
2661
|
+
Id:
|
2662
|
+
OrgId:
|
2663
|
+
Othr:
|
2664
|
+
Id: 123456789
|
2665
|
+
SchmeNm:
|
2666
|
+
Cd: BBA
|
2667
|
+
FwdgAgt:
|
2668
|
+
FinInstnId:
|
2669
|
+
BICFI: BBBBBBBB
|
2670
|
+
DbtrAgt:
|
2671
|
+
FinInstnId:
|
2672
|
+
BICFI: AAAAAAAA
|
2673
|
+
CdtrAgt:
|
2674
|
+
FinInstnId:
|
2675
|
+
BICFI: CCCCCCCC
|
2676
|
+
CdtTrfTxInf:
|
2677
|
+
PmtId:
|
2678
|
+
InstrId: 20191113001
|
2679
|
+
EndToEndId: 20191113001
|
2680
|
+
PmtTpInf:
|
2681
|
+
InstrPrty: NORM
|
2682
|
+
CtgyPurp:
|
2683
|
+
Cd: SUPP
|
2684
|
+
InstrForCdtrAgt:
|
2685
|
+
Cd: /ACC/123456789
|
2686
|
+
IntrBkSttlmAmt:
|
2687
|
+
Amt: 1000
|
2688
|
+
Ccy: EUR
|
2689
|
+
ChrgBr: SLEV
|
2690
|
+
CdtrAgt:
|
2691
|
+
FinInstnId:
|
2692
|
+
BICFI: CCCCCCCC
|
2693
|
+
Cdtr:
|
2694
|
+
Nm: Creditor Name
|
2695
|
+
CdtrAcct:
|
2696
|
+
Id:
|
2697
|
+
IBAN: BE71096123456769
|
2698
|
+
RmtInf:
|
2699
|
+
Ustrd: Payment for invoice 12345
|
2700
|
+
GenericAccountIdentification1:
|
2701
|
+
title: GenericAccountIdentification1
|
2702
|
+
type: object
|
2703
|
+
properties:
|
2704
|
+
Id:
|
2705
|
+
$ref: "#/components/schemas/Max34Text"
|
2706
|
+
SchmeNm:
|
2707
|
+
$ref: "#/components/schemas/AccountSchemeName1Choice"
|
2708
|
+
Issr:
|
2709
|
+
$ref: "#/components/schemas/Max35Text"
|
2710
|
+
required:
|
2711
|
+
- Id
|
2712
|
+
example:
|
2713
|
+
Id: 123
|
2714
|
+
SchmeNm:
|
2715
|
+
Cd: IBAN
|
2716
|
+
Issr: BIC
|
2717
|
+
GenericFinancialIdentification1:
|
2718
|
+
title: GenericFinancialIdentification1
|
2719
|
+
type: object
|
2720
|
+
properties:
|
2721
|
+
Id:
|
2722
|
+
$ref: "#/components/schemas/Max35Text"
|
2723
|
+
SchmeNm:
|
2724
|
+
$ref: "#/components/schemas/FinancialIdentificationSchemeName1Choice"
|
2725
|
+
Issr:
|
2726
|
+
$ref: "#/components/schemas/Max35Text"
|
2727
|
+
required:
|
2728
|
+
- Id
|
2729
|
+
example:
|
2730
|
+
Id: 123
|
2731
|
+
SchmeNm:
|
2732
|
+
Cd: IBAN
|
2733
|
+
Issr: BIC
|
2734
|
+
GenericIdentification3:
|
2735
|
+
title: GenericIdentification3
|
2736
|
+
type: object
|
2737
|
+
properties:
|
2738
|
+
Id:
|
2739
|
+
$ref: "#/components/schemas/Max35Text"
|
2740
|
+
Issr:
|
2741
|
+
$ref: "#/components/schemas/Max35Text"
|
2742
|
+
required:
|
2743
|
+
- Id
|
2744
|
+
example:
|
2745
|
+
Id: 123
|
2746
|
+
Issr: BIC
|
2747
|
+
GenericIdentification30:
|
2748
|
+
title: GenericIdentification30
|
2749
|
+
type: object
|
2750
|
+
properties:
|
2751
|
+
Id:
|
2752
|
+
$ref: "#/components/schemas/Exact4AlphaNumericText"
|
2753
|
+
Issr:
|
2754
|
+
$ref: "#/components/schemas/Max35Text"
|
2755
|
+
SchmeNm:
|
2756
|
+
$ref: "#/components/schemas/Max35Text"
|
2757
|
+
required:
|
2758
|
+
- Id
|
2759
|
+
- Issr
|
2760
|
+
example:
|
2761
|
+
Id: 1234
|
2762
|
+
Issr: BIC
|
2763
|
+
SchmeNm: BICFI
|
2764
|
+
GenericOrganisationIdentification1:
|
2765
|
+
title: GenericOrganisationIdentification1
|
2766
|
+
type: object
|
2767
|
+
properties:
|
2768
|
+
Id:
|
2769
|
+
$ref: "#/components/schemas/Max35Text"
|
2770
|
+
SchmeNm:
|
2771
|
+
$ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
|
2772
|
+
Issr:
|
2773
|
+
$ref: "#/components/schemas/Max35Text"
|
2774
|
+
required:
|
2775
|
+
- Id
|
2776
|
+
example:
|
2777
|
+
Id: 123
|
2778
|
+
SchmeNm:
|
2779
|
+
Cd: BIC
|
2780
|
+
Issr: BIC
|
2781
|
+
GenericOrganisationIdentification3:
|
2782
|
+
title: GenericOrganisationIdentification3
|
2783
|
+
type: object
|
2784
|
+
properties:
|
2785
|
+
Id:
|
2786
|
+
$ref: "#/components/schemas/Max256Text"
|
2787
|
+
SchmeNm:
|
2788
|
+
$ref: "#/components/schemas/OrganisationIdentificationSchemeName1Choice"
|
2789
|
+
Issr:
|
2790
|
+
$ref: "#/components/schemas/Max35Text"
|
2791
|
+
required:
|
2792
|
+
- Id
|
2793
|
+
example:
|
2794
|
+
Id: 123
|
2795
|
+
SchmeNm:
|
2796
|
+
Cd: BIC
|
2797
|
+
Issr: BIC
|
2798
|
+
GenericPersonIdentification1:
|
2799
|
+
title: GenericPersonIdentification1
|
2800
|
+
type: object
|
2801
|
+
properties:
|
2802
|
+
Id:
|
2803
|
+
$ref: "#/components/schemas/Max35Text"
|
2804
|
+
SchmeNm:
|
2805
|
+
$ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
|
2806
|
+
Issr:
|
2807
|
+
$ref: "#/components/schemas/Max35Text"
|
2808
|
+
required:
|
2809
|
+
- Id
|
2810
|
+
example:
|
2811
|
+
Id: 123
|
2812
|
+
SchmeNm:
|
2813
|
+
Cd: DRLC
|
2814
|
+
Issr: BIC
|
2815
|
+
GenericPersonIdentification2:
|
2816
|
+
title: GenericPersonIdentification2
|
2817
|
+
type: object
|
2818
|
+
properties:
|
2819
|
+
Id:
|
2820
|
+
$ref: "#/components/schemas/Max256Text"
|
2821
|
+
SchmeNm:
|
2822
|
+
$ref: "#/components/schemas/PersonIdentificationSchemeName1Choice"
|
2823
|
+
Issr:
|
2824
|
+
$ref: "#/components/schemas/Max35Text"
|
2825
|
+
required:
|
2826
|
+
- Id
|
2827
|
+
example:
|
2828
|
+
Id: 123
|
2829
|
+
SchmeNm:
|
2830
|
+
Cd: DRLC
|
2831
|
+
Issr: BIC
|
2832
|
+
GetPartiesError_IdentificationVerificationReportV03:
|
2833
|
+
title: GetPartiesError_IdentificationVerificationReportV03
|
2834
|
+
type: object
|
2835
|
+
properties:
|
2836
|
+
Assgnmt:
|
2837
|
+
$ref: "#/components/schemas/IdentificationAssignment3"
|
2838
|
+
Rpt:
|
2839
|
+
$ref: "#/components/schemas/VerificationReport4"
|
2840
|
+
SplmtryData:
|
2841
|
+
$ref: "#/components/schemas/SupplementaryData1"
|
2842
|
+
required:
|
2843
|
+
- Assgnmt
|
2844
|
+
- Rpt
|
2845
|
+
example:
|
2846
|
+
Assgnmt:
|
2847
|
+
Id: 123
|
2848
|
+
CreDtTm: "2013-03-07T16:30:00"
|
2849
|
+
Assgnr:
|
2850
|
+
Id:
|
2851
|
+
Id: 123
|
2852
|
+
SchmeNm:
|
2853
|
+
Cd: IBAN
|
2854
|
+
Issr: BIC
|
2855
|
+
Assgne:
|
2856
|
+
Id:
|
2857
|
+
Id: 123
|
2858
|
+
SchmeNm:
|
2859
|
+
Cd: IBAN
|
2860
|
+
Issr: BIC
|
2861
|
+
Rpt:
|
2862
|
+
Id: 123
|
2863
|
+
CreDtTm: "2013-03-07T16:30:00"
|
2864
|
+
RptgPty:
|
2865
|
+
Id:
|
2866
|
+
Id: 123
|
2867
|
+
SchmeNm:
|
2868
|
+
Cd: IBAN
|
2869
|
+
Issr: BIC
|
2870
|
+
RptdPty:
|
2871
|
+
Id:
|
2872
|
+
Id: 123
|
2873
|
+
SchmeNm:
|
2874
|
+
Cd: IBAN
|
2875
|
+
Issr: BIC
|
2876
|
+
RptdDoc:
|
2877
|
+
Nb: 123
|
2878
|
+
RltdDt: "2013-03-07"
|
2879
|
+
RltdDtTp:
|
2880
|
+
Cd: 123
|
2881
|
+
Rsn:
|
2882
|
+
Cd: 123
|
2883
|
+
Prtry: 123
|
2884
|
+
SplmtryData:
|
2885
|
+
PlcAndNm: 123
|
2886
|
+
Envlp: 123
|
2887
|
+
RltdDt: "2013-03-07"
|
2888
|
+
RltdDtTp:
|
2889
|
+
Cd: 123
|
2890
|
+
GetParties_IdentificationVerificationReportV03:
|
2891
|
+
title: GetParties_IdentificationVerificationReportV03
|
2892
|
+
type: object
|
2893
|
+
properties:
|
2894
|
+
Assgnmt:
|
2895
|
+
$ref: "#/components/schemas/IdentificationAssignment3"
|
2896
|
+
Rpt:
|
2897
|
+
$ref: "#/components/schemas/VerificationReport4"
|
2898
|
+
SplmtryData:
|
2899
|
+
$ref: "#/components/schemas/SupplementaryData1"
|
2900
|
+
required:
|
2901
|
+
- Assgnmt
|
2902
|
+
- Rpt
|
2903
|
+
example:
|
2904
|
+
Assgnmt:
|
2905
|
+
Id: 123
|
2906
|
+
CreDtTm: "2013-03-07T16:30:00"
|
2907
|
+
Assgnr:
|
2908
|
+
Id:
|
2909
|
+
Id: 123
|
2910
|
+
SchmeNm:
|
2911
|
+
Cd: IBAN
|
2912
|
+
Issr: BIC
|
2913
|
+
Assgne:
|
2914
|
+
Id:
|
2915
|
+
Id: 123
|
2916
|
+
SchmeNm:
|
2917
|
+
Cd: IBAN
|
2918
|
+
Issr: BIC
|
2919
|
+
Rpt:
|
2920
|
+
Id: 123
|
2921
|
+
CreDtTm: "2013-03-07T16:30:00"
|
2922
|
+
RptgPty:
|
2923
|
+
Id:
|
2924
|
+
Id: 123
|
2925
|
+
SchmeNm:
|
2926
|
+
Cd: IBAN
|
2927
|
+
Issr: BIC
|
2928
|
+
RptdPty:
|
2929
|
+
Id:
|
2930
|
+
Id: 123
|
2931
|
+
SchmeNm:
|
2932
|
+
Cd: IBAN
|
2933
|
+
Issr: BIC
|
2934
|
+
RptdDoc:
|
2935
|
+
Nb: 123
|
2936
|
+
RltdDt: "2013-03-07"
|
2937
|
+
RltdDtTp:
|
2938
|
+
Cd: 123
|
2939
|
+
Rsn:
|
2940
|
+
Cd: 123
|
2941
|
+
Prtry: 123
|
2942
|
+
SplmtryData:
|
2943
|
+
PlcAndNm: 123
|
2944
|
+
Envlp: 123
|
2945
|
+
RltdDt: "2013-03-07"
|
2946
|
+
RltdDtTp:
|
2947
|
+
Cd: 123
|
2948
|
+
GroupHeader113:
|
2949
|
+
title: GroupHeader113
|
2950
|
+
description: >
|
2951
|
+
Set of characteristics shared by all individual transactions included in
|
2952
|
+
the message.
|
2953
|
+
type: object
|
2954
|
+
properties:
|
2955
|
+
MsgId:
|
2956
|
+
$ref: "#/components/schemas/Max35Text"
|
2957
|
+
CreDtTm:
|
2958
|
+
$ref: "#/components/schemas/ISODateTime"
|
2959
|
+
NbOfTxs:
|
2960
|
+
$ref: "#/components/schemas/Max15NumericText"
|
2961
|
+
TtlIntrBkSttlmAmt:
|
2962
|
+
$ref: "#/components/schemas/ActiveCurrencyAndAmount"
|
2963
|
+
SttlmInf:
|
2964
|
+
$ref: "#/components/schemas/SettlementInstruction15"
|
2965
|
+
PmtTpInf:
|
2966
|
+
$ref: "#/components/schemas/PaymentTypeInformation28"
|
2967
|
+
CdtTrfTxInf:
|
2968
|
+
$ref: "#/components/schemas/CreditTransferTransaction68"
|
2969
|
+
required:
|
2970
|
+
- MsgId
|
2971
|
+
- CreDtTm
|
2972
|
+
- NbOfTxs
|
2973
|
+
- SttlmInf
|
2974
|
+
- CdtTrfTxInf
|
2975
|
+
example:
|
2976
|
+
MsgId: 12345
|
2977
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
2978
|
+
NbOfTxs: 1
|
2979
|
+
TtlIntrBkSttlmAmt:
|
2980
|
+
Ccy: EUR
|
2981
|
+
Value: 100
|
2982
|
+
SttlmInf:
|
2983
|
+
SttlmMtd: INDA
|
2984
|
+
SttlmAcct:
|
2985
|
+
Id:
|
2986
|
+
IBAN: BE71096123456769
|
2987
|
+
Ccy: EUR
|
2988
|
+
SttlmAcctOwnr:
|
2989
|
+
Nm: Name
|
2990
|
+
SttlmAcctSvcr:
|
2991
|
+
Nm: Name
|
2992
|
+
SttlmAgt:
|
2993
|
+
FinInstnId:
|
2994
|
+
BICFI: BIC
|
2995
|
+
PmtTpInf:
|
2996
|
+
InstrPrty: NORM
|
2997
|
+
CtgyPurp: CASH
|
2998
|
+
CdtTrfTxInf:
|
2999
|
+
PmtId:
|
3000
|
+
InstrId: 12345
|
3001
|
+
EndToEndId: 12345
|
3002
|
+
Amt:
|
3003
|
+
InstdAmt:
|
3004
|
+
Ccy: EUR
|
3005
|
+
Value: 100
|
3006
|
+
Cdtr:
|
3007
|
+
Nm: Name
|
3008
|
+
CdtrAcct:
|
3009
|
+
Id:
|
3010
|
+
IBAN: BE71096123456769
|
3011
|
+
Ccy: EUR
|
3012
|
+
CdtrAgt:
|
3013
|
+
FinInstnId:
|
3014
|
+
BICFI: BIC
|
3015
|
+
CdtrAgtAcct:
|
3016
|
+
Id:
|
3017
|
+
IBAN: BE71096123456769
|
3018
|
+
Ccy: EUR
|
3019
|
+
RmtInf:
|
3020
|
+
Ustrd: Test
|
3021
|
+
GroupHeader120:
|
3022
|
+
title: GroupHeader120
|
3023
|
+
description: >
|
3024
|
+
Set of characteristics shared by all individual transactions included in
|
3025
|
+
the message.
|
3026
|
+
type: object
|
3027
|
+
properties:
|
3028
|
+
MsgId:
|
3029
|
+
$ref: "#/components/schemas/Max35Text"
|
3030
|
+
CreDtTm:
|
3031
|
+
$ref: "#/components/schemas/ISODateTime"
|
3032
|
+
TxInfAndSts:
|
3033
|
+
$ref: "#/components/schemas/PaymentTransaction163"
|
3034
|
+
required:
|
3035
|
+
- MsgId
|
3036
|
+
- CreDtTm
|
3037
|
+
example:
|
3038
|
+
MsgId: 12345
|
3039
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
3040
|
+
TxInfAndSts:
|
3041
|
+
StsId: 12345
|
3042
|
+
OrgnlInstrId: 12345
|
3043
|
+
OrgnlEndToEndId: 12345
|
3044
|
+
OrgnlTxId: 12345
|
3045
|
+
OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000
|
3046
|
+
TxSts: RJCT
|
3047
|
+
StsRsnInf:
|
3048
|
+
Rsn: RSN
|
3049
|
+
AddtlInf: ADDITIONAL
|
3050
|
+
AccptncDtTm: "2020-01-01T00:00:00Z"
|
3051
|
+
AcctSvcrRef: ACCTSVCRREF
|
3052
|
+
ClrSysRef: CLRSYSREF
|
3053
|
+
ExctnConf: 1234567890ABCDEF
|
3054
|
+
SplmtryData:
|
3055
|
+
PlcAndNm: PLACE
|
3056
|
+
Envlp: ENVELOPE
|
3057
|
+
GroupHeader129:
|
3058
|
+
title: GroupHeader129
|
3059
|
+
description: >
|
3060
|
+
Set of characteristics shared by all individual transactions included in
|
3061
|
+
the message.
|
3062
|
+
type: object
|
3063
|
+
properties:
|
3064
|
+
MsgId:
|
3065
|
+
$ref: "#/components/schemas/Max35Text"
|
3066
|
+
CreDtTm:
|
3067
|
+
$ref: "#/components/schemas/ISODateTime"
|
3068
|
+
PmtInstrXpryDtTm:
|
3069
|
+
$ref: "#/components/schemas/ISODateTime"
|
3070
|
+
NbOfTxs:
|
3071
|
+
$ref: "#/components/schemas/Max15NumericText"
|
3072
|
+
SttlmInf:
|
3073
|
+
$ref: "#/components/schemas/SettlementInstruction15"
|
3074
|
+
CdtTrfTxInf:
|
3075
|
+
$ref: "#/components/schemas/CreditTransferTransaction67"
|
3076
|
+
required:
|
3077
|
+
- MsgId
|
3078
|
+
- CreDtTm
|
3079
|
+
- NbOfTxs
|
3080
|
+
- SttlmInf
|
3081
|
+
- CdtTrfTxInf
|
3082
|
+
example:
|
3083
|
+
MsgId: 12345
|
3084
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
3085
|
+
PmtInstrXpryDtTm: "2020-01-01T00:00:00Z"
|
3086
|
+
NbOfTxs: 1
|
3087
|
+
SttlmInf:
|
3088
|
+
SttlmMtd: INDA
|
3089
|
+
SttlmAcct:
|
3090
|
+
Id:
|
3091
|
+
IBAN: 123
|
3092
|
+
SttlmAcctOwnr:
|
3093
|
+
Nm: John Doe
|
3094
|
+
SttlmAcctSvcr:
|
3095
|
+
BICFI: 123
|
3096
|
+
CdtTrfTxInf:
|
3097
|
+
PmtId:
|
3098
|
+
InstrId: 123
|
3099
|
+
EndToEndId: 123
|
3100
|
+
PmtTpInf:
|
3101
|
+
InstrPrty: NORM
|
3102
|
+
InstdAmt:
|
3103
|
+
Amt: 123
|
3104
|
+
Ccy: EUR
|
3105
|
+
ChrgBr: SLEV
|
3106
|
+
CdtrAgt:
|
3107
|
+
FinInstnId:
|
3108
|
+
BICFI: 123
|
3109
|
+
Cdtr:
|
3110
|
+
Nm: John Doe
|
3111
|
+
CdtrAcct:
|
3112
|
+
Id:
|
3113
|
+
IBAN: 123
|
3114
|
+
RmtInf:
|
3115
|
+
Ustrd: Test
|
3116
|
+
IBAN2007Identifier:
|
3117
|
+
title: IBAN2007Identifier
|
3118
|
+
description: >
|
3119
|
+
The International Bank Account Number is a code used internationally by
|
3120
|
+
financial institutions to uniquely identify the account of a customer at
|
3121
|
+
a financial institution as described in the 2007 edition of the ISO
|
3122
|
+
13616 standard "Banking and related financial services -
|
3123
|
+
|
3124
|
+
International Bank Account Number (IBAN)" and replaced by the more
|
3125
|
+
recent edition of the standard.
|
3126
|
+
type: string
|
3127
|
+
pattern: ^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$
|
3128
|
+
example: FR1420041010050500013M02606
|
3129
|
+
ISODate:
|
3130
|
+
title: ISODate
|
3131
|
+
description: >
|
3132
|
+
A particular point in the progression of time in a calendar year
|
3133
|
+
expressed in the YYYY-MM-DD format. This representation is defined in
|
3134
|
+
"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28
|
3135
|
+
October 2004" which is aligned with ISO 8601.
|
3136
|
+
type: string
|
3137
|
+
format: date
|
3138
|
+
example: "2013-03-07"
|
3139
|
+
ISODateTime:
|
3140
|
+
title: ISODateTime
|
3141
|
+
description: >
|
3142
|
+
A particular point in the progression of time defined by a mandatory
|
3143
|
+
|
3144
|
+
date and a mandatory time component, expressed in either UTC time
|
3145
|
+
|
3146
|
+
format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format
|
3147
|
+
|
3148
|
+
(YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format
|
3149
|
+
|
3150
|
+
(YYYY-MM-DDThh:mm:ss.sss). These representations are defined in
|
3151
|
+
|
3152
|
+
"XML Schema Part 2: Datatypes Second Edition -
|
3153
|
+
|
3154
|
+
W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
|
3155
|
+
|
3156
|
+
|
3157
|
+
Note on the time format:
|
3158
|
+
|
3159
|
+
1) beginning / end of calendar day
|
3160
|
+
|
3161
|
+
00:00:00 = the beginning of a calendar day
|
3162
|
+
|
3163
|
+
24:00:00 = the end of a calendar day
|
3164
|
+
|
3165
|
+
|
3166
|
+
2) fractions of second in time format
|
3167
|
+
|
3168
|
+
Decimal fractions of seconds may be included. In this case, the
|
3169
|
+
|
3170
|
+
involved parties shall agree on the maximum number of digits that are
|
3171
|
+
allowed.
|
3172
|
+
type: string
|
3173
|
+
format: datetime
|
3174
|
+
example: "2013-03-07T14:44:30.000Z"
|
3175
|
+
ISOYear:
|
3176
|
+
title: ISOYear
|
3177
|
+
description: |
|
3178
|
+
Year represented by YYYY (ISO 8601).
|
3179
|
+
type: string
|
3180
|
+
pattern: ^\d{4}(Z|([+-]\d{2}:\d{2})){0,1}$
|
3181
|
+
example: 2019
|
3182
|
+
IdentificationAssignment3:
|
3183
|
+
title: IdentificationAssignment3
|
3184
|
+
type: object
|
3185
|
+
properties:
|
3186
|
+
MsgId:
|
3187
|
+
$ref: "#/components/schemas/Max35Text"
|
3188
|
+
CreDtTm:
|
3189
|
+
$ref: "#/components/schemas/ISODateTime"
|
3190
|
+
Assgnr:
|
3191
|
+
$ref: "#/components/schemas/Party40Choice"
|
3192
|
+
Assgne:
|
3193
|
+
$ref: "#/components/schemas/Party40Choice"
|
3194
|
+
required:
|
3195
|
+
- MsgId
|
3196
|
+
- CreDtTm
|
3197
|
+
- Assgnr
|
3198
|
+
- Assgne
|
3199
|
+
example:
|
3200
|
+
MsgId: 123
|
3201
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
3202
|
+
Assgnr:
|
3203
|
+
OrgId:
|
3204
|
+
Othr:
|
3205
|
+
Id: 123
|
3206
|
+
SchmeNm:
|
3207
|
+
Cd: BIC
|
3208
|
+
Issr: BIC
|
3209
|
+
Assgne:
|
3210
|
+
OrgId:
|
3211
|
+
Othr:
|
3212
|
+
Id: 123
|
3213
|
+
SchmeNm:
|
3214
|
+
Cd: BIC
|
3215
|
+
Issr: BIC
|
3216
|
+
IdentificationInformation4:
|
3217
|
+
title: IdentificationInformation4
|
3218
|
+
type: object
|
3219
|
+
properties:
|
3220
|
+
Pty:
|
3221
|
+
$ref: "#/components/schemas/PartyIdentification135"
|
3222
|
+
Acct:
|
3223
|
+
$ref: "#/components/schemas/CashAccount40"
|
3224
|
+
Agt:
|
3225
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6"
|
3226
|
+
example:
|
3227
|
+
Pty:
|
3228
|
+
Id:
|
3229
|
+
OrgId:
|
3230
|
+
AnyBIC:
|
3231
|
+
BICFI: BICFI
|
3232
|
+
CtryOfRes: FI
|
3233
|
+
Acct:
|
3234
|
+
Id:
|
3235
|
+
IBAN: FI2112345600000785
|
3236
|
+
Agt:
|
3237
|
+
FinInstnId:
|
3238
|
+
BICFI: BICFI
|
3239
|
+
IdentificationVerificationIndicator:
|
3240
|
+
title: IdentificationVerificationIndicator
|
3241
|
+
type: boolean
|
3242
|
+
example: true
|
3243
|
+
Instruction4Code:
|
3244
|
+
title: Instruction4Code
|
3245
|
+
description: >
|
3246
|
+
Specifies further instructions concerning the processing of a payment
|
3247
|
+
instruction, provided by the sending clearing agent to the next
|
3248
|
+
agent(s).
|
3249
|
+
|
3250
|
+
PHOA PhoneNextAgent Please advise/contact next agent by phone.
|
3251
|
+
|
3252
|
+
TELA TelecomNextAgent Please advise/contact next agent by the most
|
3253
|
+
efficient means of telecommunication.
|
3254
|
+
type: string
|
3255
|
+
enum:
|
3256
|
+
- PHOA
|
3257
|
+
- TELA
|
3258
|
+
example: PHOA
|
3259
|
+
InstructionForCreditorAgent3:
|
3260
|
+
title: InstructionForCreditorAgent3
|
3261
|
+
description: >
|
3262
|
+
Further information related to the processing of the payment
|
3263
|
+
instruction, provided by the initiating party, and intended for the
|
3264
|
+
creditor agent.
|
3265
|
+
type: object
|
3266
|
+
properties:
|
3267
|
+
Cd:
|
3268
|
+
$ref: "#/components/schemas/ExternalCreditorAgentInstruction1Code"
|
3269
|
+
InstrInf:
|
3270
|
+
$ref: "#/components/schemas/Max140Text"
|
3271
|
+
example:
|
3272
|
+
Cd: PHOA
|
3273
|
+
InstrInf: Please advise/contact next agent by phone.
|
3274
|
+
InstructionForNextAgent1:
|
3275
|
+
title: InstructionForNextAgent1
|
3276
|
+
description: >
|
3277
|
+
Further information related to the processing of the payment
|
3278
|
+
instruction, provided by the initiating party, and intended for the
|
3279
|
+
creditor agent.
|
3280
|
+
type: object
|
3281
|
+
properties:
|
3282
|
+
Cd:
|
3283
|
+
$ref: "#/components/schemas/Instruction4Code"
|
3284
|
+
InstrInf:
|
3285
|
+
$ref: "#/components/schemas/Max140Text"
|
3286
|
+
example:
|
3287
|
+
Cd: PHOA
|
3288
|
+
InstrInf: Please advise/contact next agent by phone
|
3289
|
+
LEIIdentifier:
|
3290
|
+
title: LEIIdentifier
|
3291
|
+
description: >
|
3292
|
+
Legal Entity Identifier is a code allocated to a party as described in
|
3293
|
+
ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
|
3294
|
+
^([0-9A-Z]{18,18}[0-9]{2,2})$
|
3295
|
+
type: string
|
3296
|
+
pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$
|
3297
|
+
example: 529900T8BM49AURSDO55
|
3298
|
+
LocalInstrument2Choice:
|
3299
|
+
title: LocalInstrument2Choice
|
3300
|
+
type: object
|
3301
|
+
properties:
|
3302
|
+
Cd:
|
3303
|
+
$ref: "#/components/schemas/ExternalLocalInstrument1Code"
|
3304
|
+
Prtry:
|
3305
|
+
$ref: "#/components/schemas/Max35Text"
|
3306
|
+
oneOf:
|
3307
|
+
- required:
|
3308
|
+
- Cd
|
3309
|
+
- required:
|
3310
|
+
- Prtry
|
3311
|
+
example:
|
3312
|
+
Cd: CH03
|
3313
|
+
Max105Text:
|
3314
|
+
title: Max105Text
|
3315
|
+
description: |
|
3316
|
+
Specifies a character string with a maximum length of 105 characters.
|
3317
|
+
type: string
|
3318
|
+
minLength: 1
|
3319
|
+
maxLength: 105
|
3320
|
+
example: 12345
|
3321
|
+
Max10Text:
|
3322
|
+
title: Max10Text
|
3323
|
+
description: |
|
3324
|
+
Specifies a character string with a maximum length of 10 characters.
|
3325
|
+
type: string
|
3326
|
+
minLength: 1
|
3327
|
+
maxLength: 10
|
3328
|
+
example: 1234567890
|
3329
|
+
Max128Text:
|
3330
|
+
title: Max128Text
|
3331
|
+
description: |
|
3332
|
+
Specifies a character string with a maximum length of 128 characters.
|
3333
|
+
type: string
|
3334
|
+
minLength: 1
|
3335
|
+
maxLength: 128
|
3336
|
+
example: 12345
|
3337
|
+
Max140Text:
|
3338
|
+
title: Max140Text
|
3339
|
+
description: |
|
3340
|
+
Specifies a character string with a maximum length of 140 characters.
|
3341
|
+
type: string
|
3342
|
+
minLength: 1
|
3343
|
+
maxLength: 140
|
3344
|
+
example: 12345
|
3345
|
+
Max15NumericText:
|
3346
|
+
title: Max15NumericText
|
3347
|
+
description: |
|
3348
|
+
Specifies a numeric string with a maximum length of 15 digits.
|
3349
|
+
type: string
|
3350
|
+
pattern: ^[0-9]{1,15}$
|
3351
|
+
example: 123456789012345
|
3352
|
+
Max16Text:
|
3353
|
+
title: Max16Text
|
3354
|
+
description: |
|
3355
|
+
Specifies a character string with a maximum length of 16 characters.
|
3356
|
+
type: string
|
3357
|
+
minLength: 1
|
3358
|
+
maxLength: 16
|
3359
|
+
example: 1234567890123456
|
3360
|
+
Max2048Text:
|
3361
|
+
title: Max2048Text
|
3362
|
+
description: |
|
3363
|
+
Specifies a character string with a maximum length of 2048 characters.
|
3364
|
+
type: string
|
3365
|
+
minLength: 1
|
3366
|
+
maxLength: 2048
|
3367
|
+
example: 2048
|
3368
|
+
Max256Text:
|
3369
|
+
title: Max256Text
|
3370
|
+
description: |
|
3371
|
+
Specifies a character string with a maximum length of 256 characters.
|
3372
|
+
type: string
|
3373
|
+
minLength: 1
|
3374
|
+
maxLength: 256
|
3375
|
+
example: 256
|
3376
|
+
Max34Text:
|
3377
|
+
title: Max34Text
|
3378
|
+
description: |
|
3379
|
+
Specifies a character string with a maximum length of 34 characters.
|
3380
|
+
type: string
|
3381
|
+
minLength: 1
|
3382
|
+
maxLength: 34
|
3383
|
+
example: 1.2345678901234568e+33
|
3384
|
+
Max350Text:
|
3385
|
+
title: Max350Text
|
3386
|
+
description: |
|
3387
|
+
Specifies a character string with a maximum length of 350 characters.
|
3388
|
+
type: string
|
3389
|
+
minLength: 1
|
3390
|
+
maxLength: 350
|
3391
|
+
example: 350
|
3392
|
+
Max35Text:
|
3393
|
+
title: Max35Text
|
3394
|
+
description: |
|
3395
|
+
Specifies a character string with a maximum length of 35 characters.
|
3396
|
+
type: string
|
3397
|
+
minLength: 1
|
3398
|
+
maxLength: 35
|
3399
|
+
example: 1.234567890123457e+34
|
3400
|
+
Max4Text:
|
3401
|
+
title: Max4Text
|
3402
|
+
description: |
|
3403
|
+
Specifies a character string with a maximum length of 4 characters.
|
3404
|
+
type: string
|
3405
|
+
minLength: 1
|
3406
|
+
maxLength: 4
|
3407
|
+
example: 1234
|
3408
|
+
Max70Text:
|
3409
|
+
title: Max70Text
|
3410
|
+
description: |
|
3411
|
+
Specifies a character string with a maximum length of 70 characters.
|
3412
|
+
type: string
|
3413
|
+
minLength: 1
|
3414
|
+
maxLength: 70
|
3415
|
+
example: 1.2345678901234567e+99
|
3416
|
+
NamePrefix2Code:
|
3417
|
+
description: |
|
3418
|
+
Specifies the terms used to formally address a person.
|
3419
|
+
enum:
|
3420
|
+
- DOCT
|
3421
|
+
- MADM
|
3422
|
+
- MISS
|
3423
|
+
- MIST
|
3424
|
+
- MIKS
|
3425
|
+
type: string
|
3426
|
+
example: DOCT
|
3427
|
+
Number:
|
3428
|
+
title: Number
|
3429
|
+
type: string
|
3430
|
+
pattern: ^[\d\-\.\,]{1,18}$
|
3431
|
+
example: 256
|
3432
|
+
OrganisationIdentification29:
|
3433
|
+
title: OrganisationIdentification29
|
3434
|
+
description: |
|
3435
|
+
Unique and unambiguous way to identify an organisation.
|
3436
|
+
type: object
|
3437
|
+
properties:
|
3438
|
+
AnyBIC:
|
3439
|
+
$ref: "#/components/schemas/AnyBICDec2014Identifier"
|
3440
|
+
LEI:
|
3441
|
+
$ref: "#/components/schemas/LEIIdentifier"
|
3442
|
+
Othr:
|
3443
|
+
$ref: "#/components/schemas/GenericOrganisationIdentification1"
|
3444
|
+
example:
|
3445
|
+
AnyBIC: BICFI
|
3446
|
+
LEI: 529900T8BM49AURSDO55
|
3447
|
+
Othr:
|
3448
|
+
Id: 123
|
3449
|
+
SchmeNm:
|
3450
|
+
Cd: BIC
|
3451
|
+
Issr: BIC
|
3452
|
+
OrganisationIdentification39:
|
3453
|
+
title: OrganisationIdentification39
|
3454
|
+
description: |
|
3455
|
+
Unique and unambiguous way to identify an organisation.
|
3456
|
+
type: object
|
3457
|
+
properties:
|
3458
|
+
AnyBIC:
|
3459
|
+
$ref: "#/components/schemas/AnyBICDec2014Identifier"
|
3460
|
+
LEI:
|
3461
|
+
$ref: "#/components/schemas/LEIIdentifier"
|
3462
|
+
Othr:
|
3463
|
+
$ref: "#/components/schemas/GenericOrganisationIdentification3"
|
3464
|
+
example:
|
3465
|
+
AnyBIC: BICFI
|
3466
|
+
LEI: 529900T8BM49AURSDO55
|
3467
|
+
Othr:
|
3468
|
+
Id: 123
|
3469
|
+
SchmeNm:
|
3470
|
+
Cd: BIC
|
3471
|
+
Issr: BIC
|
3472
|
+
OrganisationIdentificationSchemeName1Choice:
|
3473
|
+
title: OrganisationIdentificationSchemeName1Choice
|
3474
|
+
description: |
|
3475
|
+
Choice of format for the organisation identification.
|
3476
|
+
type: object
|
3477
|
+
properties:
|
3478
|
+
Cd:
|
3479
|
+
$ref: "#/components/schemas/ExternalOrganisationIdentification1Code"
|
3480
|
+
Prtry:
|
3481
|
+
$ref: "#/components/schemas/Max35Text"
|
3482
|
+
oneOf:
|
3483
|
+
- required:
|
3484
|
+
- Cd
|
3485
|
+
- required:
|
3486
|
+
- Prtry
|
3487
|
+
example:
|
3488
|
+
Cd: BIC
|
3489
|
+
OtherContact1:
|
3490
|
+
title: OtherContact1
|
3491
|
+
description: >
|
3492
|
+
Communication device number or electronic address used for
|
3493
|
+
communication.
|
3494
|
+
type: object
|
3495
|
+
properties:
|
3496
|
+
ChanlTp:
|
3497
|
+
$ref: "#/components/schemas/Max4Text"
|
3498
|
+
Id:
|
3499
|
+
$ref: "#/components/schemas/Max128Text"
|
3500
|
+
required:
|
3501
|
+
- ChanlTp
|
3502
|
+
example:
|
3503
|
+
ChanlTp: PHON
|
3504
|
+
Id: 1234567890
|
3505
|
+
PacsError_FIToFIPaymentStatusReportV15:
|
3506
|
+
title: PacsError_FIToFIPaymentStatusReportV15
|
3507
|
+
type: object
|
3508
|
+
properties:
|
3509
|
+
GrpHdr:
|
3510
|
+
$ref: "#/components/schemas/GroupHeader120"
|
3511
|
+
TxInfAndSts:
|
3512
|
+
$ref: "#/components/schemas/PaymentTransaction163"
|
3513
|
+
SplmtryData:
|
3514
|
+
$ref: "#/components/schemas/SupplementaryData1"
|
3515
|
+
required:
|
3516
|
+
- GrpHdr
|
3517
|
+
example:
|
3518
|
+
GrpHdr:
|
3519
|
+
MsgId: 12345
|
3520
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
3521
|
+
NbOfTxs: 1
|
3522
|
+
SttlmInf:
|
3523
|
+
SttlmMtd: INDA
|
3524
|
+
SttlmDt: "2020-01-01"
|
3525
|
+
InstgAgt:
|
3526
|
+
FinInstnId:
|
3527
|
+
BICFI: BICFI
|
3528
|
+
InstdAgt:
|
3529
|
+
FinInstnId:
|
3530
|
+
BICFI: BICFI
|
3531
|
+
TxInfAndSts:
|
3532
|
+
OrgnlInstrId: 12345
|
3533
|
+
OrgnlEndToEndId: 12345
|
3534
|
+
TxSts: RJCT
|
3535
|
+
StsRsnInf:
|
3536
|
+
Rsn: RSN
|
3537
|
+
AddtlInf: ADDITIONAL
|
3538
|
+
SplmtryData:
|
3539
|
+
PlcAndNm: PLACE
|
3540
|
+
Envlp: ENVELOPE
|
3541
|
+
PacsStatus_FIToFIPaymentStatusReportV15:
|
3542
|
+
title: PacsStatus_FIToFIPaymentStatusReportV15
|
3543
|
+
description: |
|
3544
|
+
Unsure on description.
|
3545
|
+
type: object
|
3546
|
+
properties:
|
3547
|
+
GrpHdr:
|
3548
|
+
$ref: "#/components/schemas/GroupHeader120"
|
3549
|
+
required:
|
3550
|
+
- GrpHdr
|
3551
|
+
example:
|
3552
|
+
GrpHdr:
|
3553
|
+
MsgId: 123
|
3554
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
3555
|
+
NbOfTxs: 1
|
3556
|
+
SttlmInf:
|
3557
|
+
SttlmMtd: INDA
|
3558
|
+
SttlmDt: "2020-01-01"
|
3559
|
+
SttlmTmIndctn: RTGS
|
3560
|
+
SttlmTmReq: "2020-01-01T00:00:00Z"
|
3561
|
+
SttlmAcct:
|
3562
|
+
Id:
|
3563
|
+
Othr:
|
3564
|
+
Id: 123
|
3565
|
+
SchmeNm:
|
3566
|
+
Cd: IBAN
|
3567
|
+
Issr: BIC
|
3568
|
+
ClrSys:
|
3569
|
+
Prtry: 123
|
3570
|
+
InstgAgt:
|
3571
|
+
FinInstnId:
|
3572
|
+
BICFI: 123
|
3573
|
+
InstdAgt:
|
3574
|
+
FinInstnId:
|
3575
|
+
BICFI: 123
|
3576
|
+
InstgAgt:
|
3577
|
+
FinInstnId:
|
3578
|
+
BICFI: 123
|
3579
|
+
InstdAgt:
|
3580
|
+
FinInstnId:
|
3581
|
+
BICFI: 123
|
3582
|
+
IntrBkSttlmAmt:
|
3583
|
+
Amt: 123
|
3584
|
+
Ccy: EUR
|
3585
|
+
IntrBkSttlmDt: "2020-01-01"
|
3586
|
+
TxSts: ACCP
|
3587
|
+
StsRsnInf:
|
3588
|
+
Orgtr:
|
3589
|
+
Id:
|
3590
|
+
Othr:
|
3591
|
+
Id: 123
|
3592
|
+
SchmeNm:
|
3593
|
+
Cd: IBAN
|
3594
|
+
Issr: BIC
|
3595
|
+
Rsn:
|
3596
|
+
Cd: 123
|
3597
|
+
Prtry: 123
|
3598
|
+
TxInfAndSts:
|
3599
|
+
OrgnlInstrId: 123
|
3600
|
+
OrgnlEndToEndId: 123
|
3601
|
+
TxSts: ACCP
|
3602
|
+
StsRsnInf:
|
3603
|
+
Orgtr:
|
3604
|
+
Id:
|
3605
|
+
Othr:
|
3606
|
+
Id: 123
|
3607
|
+
SchmeNm:
|
3608
|
+
Cd: IBAN
|
3609
|
+
Issr: BIC
|
3610
|
+
Rsn:
|
3611
|
+
Cd: 123
|
3612
|
+
Prtry: 123
|
3613
|
+
ChrgsInf:
|
3614
|
+
Amt: 123
|
3615
|
+
Ccy: EUR
|
3616
|
+
IntrBkSttlmAmt:
|
3617
|
+
Amt: 123
|
3618
|
+
Ccy: EUR
|
3619
|
+
IntrBkSttlmDt: "2020-01-01"
|
3620
|
+
SttlmTmIndctn: RTGS
|
3621
|
+
Party38Choice:
|
3622
|
+
title: Party38Choice
|
3623
|
+
description: |
|
3624
|
+
Nature or use of the account.
|
3625
|
+
type: object
|
3626
|
+
properties:
|
3627
|
+
OrgId:
|
3628
|
+
$ref: "#/components/schemas/OrganisationIdentification29"
|
3629
|
+
PrvtId:
|
3630
|
+
$ref: "#/components/schemas/PersonIdentification13"
|
3631
|
+
oneOf:
|
3632
|
+
- required:
|
3633
|
+
- OrgId
|
3634
|
+
- required:
|
3635
|
+
- PrvtId
|
3636
|
+
example:
|
3637
|
+
OrgId:
|
3638
|
+
AnyBIC: BIC
|
3639
|
+
PrvtId:
|
3640
|
+
DtAndPlcOfBirth:
|
3641
|
+
Dt: "2018-01-01"
|
3642
|
+
CityOfBirth: City
|
3643
|
+
Party40Choice:
|
3644
|
+
title: Party40Choice
|
3645
|
+
description: |
|
3646
|
+
Nature or use of the account.
|
3647
|
+
type: object
|
3648
|
+
properties:
|
3649
|
+
Pty:
|
3650
|
+
$ref: "#/components/schemas/PartyIdentification135"
|
3651
|
+
Agt:
|
3652
|
+
$ref: "#/components/schemas/BranchAndFinancialInstitutionIdentification6"
|
3653
|
+
oneOf:
|
3654
|
+
- required:
|
3655
|
+
- Pty
|
3656
|
+
- required:
|
3657
|
+
- Agt
|
3658
|
+
example:
|
3659
|
+
Pty:
|
3660
|
+
Nm: Name
|
3661
|
+
PstlAdr:
|
3662
|
+
Ctry: US
|
3663
|
+
AdrLine:
|
3664
|
+
- Line1
|
3665
|
+
- Line2
|
3666
|
+
Id:
|
3667
|
+
OrgId:
|
3668
|
+
AnyBIC: BIC
|
3669
|
+
Agt:
|
3670
|
+
FinInstnId:
|
3671
|
+
BICFI: BUKBGB22
|
3672
|
+
BrnchId:
|
3673
|
+
Id: 12345
|
3674
|
+
Nm: Oxford Street Branch
|
3675
|
+
PstlAdr:
|
3676
|
+
Ctry: GB
|
3677
|
+
AdrLine:
|
3678
|
+
- 1 Oxford Street
|
3679
|
+
- London
|
3680
|
+
- UK
|
3681
|
+
Party52Choice:
|
3682
|
+
title: Party52Choice
|
3683
|
+
description: |
|
3684
|
+
Nature or use of the account.
|
3685
|
+
type: object
|
3686
|
+
properties:
|
3687
|
+
OrgId:
|
3688
|
+
$ref: "#/components/schemas/OrganisationIdentification39"
|
3689
|
+
PrvtId:
|
3690
|
+
$ref: "#/components/schemas/PersonIdentification18"
|
3691
|
+
oneOf:
|
3692
|
+
- required:
|
3693
|
+
- OrgId
|
3694
|
+
- required:
|
3695
|
+
- PrvtId
|
3696
|
+
example:
|
3697
|
+
OrgId:
|
3698
|
+
AnyBIC: BIC
|
3699
|
+
PrvtId:
|
3700
|
+
DtAndPlcOfBirth:
|
3701
|
+
Dt: "2018-01-01"
|
3702
|
+
CityOfBirth: City
|
3703
|
+
PartyIdentification135:
|
3704
|
+
title: PartyIdentification135
|
3705
|
+
description: |
|
3706
|
+
Specifies the identification of a person or an organisation.
|
3707
|
+
type: object
|
3708
|
+
properties:
|
3709
|
+
Nm:
|
3710
|
+
$ref: "#/components/schemas/Max140Text"
|
3711
|
+
PstlAdr:
|
3712
|
+
$ref: "#/components/schemas/PostalAddress24"
|
3713
|
+
Id:
|
3714
|
+
$ref: "#/components/schemas/Party38Choice"
|
3715
|
+
CtryOfRes:
|
3716
|
+
$ref: "#/components/schemas/CountryCode"
|
3717
|
+
CtctDtls:
|
3718
|
+
$ref: "#/components/schemas/Contact4"
|
3719
|
+
example:
|
3720
|
+
Nm: John Doe
|
3721
|
+
PstlAdr:
|
3722
|
+
Ctry: BE
|
3723
|
+
AdrLine:
|
3724
|
+
- Rue du Marché 45
|
3725
|
+
- Brussels
|
3726
|
+
- BE
|
3727
|
+
Id:
|
3728
|
+
OrgId:
|
3729
|
+
AnyBIC: CCCCUS33
|
3730
|
+
CtryOfRes: BE
|
3731
|
+
CtctDtls:
|
3732
|
+
NmPrfx: Mr
|
3733
|
+
Nm: John Doe
|
3734
|
+
PhneNb: +123-123-321
|
3735
|
+
MobNb: +123-123-321
|
3736
|
+
FaxNb: +123-123-321
|
3737
|
+
EmailAdr: null
|
3738
|
+
PartyIdentification272:
|
3739
|
+
title: PartyIdentification272
|
3740
|
+
description: |
|
3741
|
+
Specifies the identification of a person or an organisation.
|
3742
|
+
type: object
|
3743
|
+
properties:
|
3744
|
+
Nm:
|
3745
|
+
$ref: "#/components/schemas/Max140Text"
|
3746
|
+
PstlAdr:
|
3747
|
+
$ref: "#/components/schemas/PostalAddress27"
|
3748
|
+
Id:
|
3749
|
+
$ref: "#/components/schemas/Party52Choice"
|
3750
|
+
CtryOfRes:
|
3751
|
+
$ref: "#/components/schemas/CountryCode"
|
3752
|
+
CtctDtls:
|
3753
|
+
$ref: "#/components/schemas/Contact13"
|
3754
|
+
example:
|
3755
|
+
Nm: John Doe
|
3756
|
+
PstlAdr:
|
3757
|
+
AdrTp: ADDR
|
3758
|
+
Dept: Dept
|
3759
|
+
SubDept: SubDept
|
3760
|
+
StrtNm: StrtNm
|
3761
|
+
BldgNb: BldgNb
|
3762
|
+
PstCd: PstCd
|
3763
|
+
TwnNm: TwnNm
|
3764
|
+
CtrySubDvsn: CtrySubDvsn
|
3765
|
+
Ctry: Ctry
|
3766
|
+
Id:
|
3767
|
+
OrgId:
|
3768
|
+
AnyBIC: BIC
|
3769
|
+
PrvtId:
|
3770
|
+
DtAndPlcOfBirth:
|
3771
|
+
Dt: "2018-01-01"
|
3772
|
+
CityOfBirth: City
|
3773
|
+
CtryOfRes: BE
|
3774
|
+
CtctDtls:
|
3775
|
+
NmPrfx: Mr
|
3776
|
+
Nm: John Doe
|
3777
|
+
PhneNb: +123-123-321
|
3778
|
+
MobNb: +123-123-321
|
3779
|
+
FaxNb: +123-123-321
|
3780
|
+
EmailAdr: null
|
3781
|
+
PaymentIdentification13:
|
3782
|
+
title: PaymentIdentification13
|
3783
|
+
description: |
|
3784
|
+
Provides further means of referencing a payment transaction.
|
3785
|
+
type: object
|
3786
|
+
properties:
|
3787
|
+
InstrId:
|
3788
|
+
$ref: "#/components/schemas/Max35Text"
|
3789
|
+
EndToEndId:
|
3790
|
+
$ref: "#/components/schemas/Max35Text"
|
3791
|
+
TxId:
|
3792
|
+
$ref: "#/components/schemas/Max35Text"
|
3793
|
+
UETR:
|
3794
|
+
$ref: "#/components/schemas/UUIDv4Identifier"
|
3795
|
+
ClrSysRef:
|
3796
|
+
$ref: "#/components/schemas/Max35Text"
|
3797
|
+
required:
|
3798
|
+
- EndToEndId
|
3799
|
+
example:
|
3800
|
+
InstrId: INSTRUCTIONID
|
3801
|
+
EndToEndId: ENDTOENDID
|
3802
|
+
TxId: TRANSACTIONID
|
3803
|
+
UETR: 123e4567-e89b-12d3-a456-426614174000
|
3804
|
+
ClrSysRef: CLRSYSREF
|
3805
|
+
PaymentTransaction163:
|
3806
|
+
title: PaymentTransaction163
|
3807
|
+
description: >
|
3808
|
+
Provides further details on the original transactions, to which the
|
3809
|
+
status report message refers.
|
3810
|
+
type: object
|
3811
|
+
properties:
|
3812
|
+
StsId:
|
3813
|
+
$ref: "#/components/schemas/Max35Text"
|
3814
|
+
OrgnlInstrId:
|
3815
|
+
$ref: "#/components/schemas/Max35Text"
|
3816
|
+
OrgnlEndToEndId:
|
3817
|
+
$ref: "#/components/schemas/Max35Text"
|
3818
|
+
OrgnlTxId:
|
3819
|
+
$ref: "#/components/schemas/Max35Text"
|
3820
|
+
OrgnlUETR:
|
3821
|
+
$ref: "#/components/schemas/UUIDv4Identifier"
|
3822
|
+
TxSts:
|
3823
|
+
$ref: "#/components/schemas/ExternalPaymentTransactionStatus1Code"
|
3824
|
+
StsRsnInf:
|
3825
|
+
$ref: "#/components/schemas/StatusReasonInformation14"
|
3826
|
+
AccptncDtTm:
|
3827
|
+
$ref: "#/components/schemas/ISODateTime"
|
3828
|
+
AcctSvcrRef:
|
3829
|
+
$ref: "#/components/schemas/Max35Text"
|
3830
|
+
ClrSysRef:
|
3831
|
+
$ref: "#/components/schemas/Max35Text"
|
3832
|
+
ExctnConf:
|
3833
|
+
$ref: "#/components/schemas/Exact32HexBinaryText"
|
3834
|
+
SplmtryData:
|
3835
|
+
$ref: "#/components/schemas/SupplementaryData1"
|
3836
|
+
example:
|
3837
|
+
StsId: 12345
|
3838
|
+
OrgnlInstrId: 12345
|
3839
|
+
OrgnlEndToEndId: 12345
|
3840
|
+
OrgnlTxId: 12345
|
3841
|
+
OrgnlUETR: 123e4567-e89b-12d3-a456-426614174000
|
3842
|
+
TxSts: RJCT
|
3843
|
+
StsRsnInf:
|
3844
|
+
Rsn: RSN
|
3845
|
+
AddtlInf: ADDITIONAL
|
3846
|
+
AccptncDtTm: "2020-01-01T00:00:00Z"
|
3847
|
+
AcctSvcrRef: ACCTSVCRREF
|
3848
|
+
ClrSysRef: CLRSYSREF
|
3849
|
+
ExctnConf: 1234567890ABCDEF
|
3850
|
+
SplmtryData:
|
3851
|
+
PlcAndNm: PLACE
|
3852
|
+
Envlp: ENVELOPE
|
3853
|
+
PaymentTypeInformation28:
|
3854
|
+
title: PaymentTypeInformation28
|
3855
|
+
description: |
|
3856
|
+
Provides further details of the type of payment.
|
3857
|
+
type: object
|
3858
|
+
properties:
|
3859
|
+
InstrPrty:
|
3860
|
+
$ref: "#/components/schemas/Priority2Code"
|
3861
|
+
ClrChanl:
|
3862
|
+
$ref: "#/components/schemas/ClearingChannel2Code"
|
3863
|
+
SvcLvl:
|
3864
|
+
$ref: "#/components/schemas/ServiceLevel8Choice"
|
3865
|
+
LclInstrm:
|
3866
|
+
$ref: "#/components/schemas/LocalInstrument2Choice"
|
3867
|
+
CtgyPurp:
|
3868
|
+
$ref: "#/components/schemas/CategoryPurpose1Choice"
|
3869
|
+
example:
|
3870
|
+
InstrPrty: NORM
|
3871
|
+
ClrChanl: RTGS
|
3872
|
+
SvcLvl:
|
3873
|
+
Cd: SEPA
|
3874
|
+
LclInstrm:
|
3875
|
+
Cd: CORE
|
3876
|
+
CtgyPurp:
|
3877
|
+
Cd: CASH
|
3878
|
+
PercentageRate:
|
3879
|
+
title: PercentageRate
|
3880
|
+
type: string
|
3881
|
+
pattern: ^(?=[\d\-\.\,]{1,11}$)([\d\-\,\.]{1,10})?$
|
3882
|
+
example: 1234
|
3883
|
+
PersonIdentification13:
|
3884
|
+
title: PersonIdentification13
|
3885
|
+
description: |
|
3886
|
+
Unique and unambiguous way to identify a person.
|
3887
|
+
type: object
|
3888
|
+
properties:
|
3889
|
+
DtAndPlcOfBirth:
|
3890
|
+
$ref: "#/components/schemas/DateAndPlaceOfBirth1"
|
3891
|
+
Othr:
|
3892
|
+
$ref: "#/components/schemas/GenericPersonIdentification1"
|
3893
|
+
example:
|
3894
|
+
DtAndPlcOfBirth:
|
3895
|
+
Dt: "2018-01-01"
|
3896
|
+
CityOfBirth: City
|
3897
|
+
Othr:
|
3898
|
+
Id: 123
|
3899
|
+
SchmeNm:
|
3900
|
+
Cd: CUST
|
3901
|
+
Prtry: 1
|
3902
|
+
PersonIdentification18:
|
3903
|
+
title: PersonIdentification18
|
3904
|
+
description: |
|
3905
|
+
Unique and unambiguous way to identify a person.
|
3906
|
+
type: object
|
3907
|
+
properties:
|
3908
|
+
DtAndPlcOfBirth:
|
3909
|
+
$ref: "#/components/schemas/DateAndPlaceOfBirth1"
|
3910
|
+
Othr:
|
3911
|
+
$ref: "#/components/schemas/GenericPersonIdentification2"
|
3912
|
+
example:
|
3913
|
+
DtAndPlcOfBirth:
|
3914
|
+
Dt: "2018-01-01"
|
3915
|
+
CityOfBirth: City
|
3916
|
+
Othr:
|
3917
|
+
Id: 123
|
3918
|
+
SchmeNm:
|
3919
|
+
Cd: CUST
|
3920
|
+
Prtry: 1
|
3921
|
+
PersonIdentificationSchemeName1Choice:
|
3922
|
+
title: PersonIdentificationSchemeName1Choice
|
3923
|
+
description: |
|
3924
|
+
Sets of elements to identify a name of the identification scheme.
|
3925
|
+
type: object
|
3926
|
+
properties:
|
3927
|
+
Cd:
|
3928
|
+
$ref: "#/components/schemas/ExternalPersonIdentification1Code"
|
3929
|
+
Prtry:
|
3930
|
+
$ref: "#/components/schemas/Max35Text"
|
3931
|
+
oneOf:
|
3932
|
+
- required:
|
3933
|
+
- Cd
|
3934
|
+
- required:
|
3935
|
+
- Prtry
|
3936
|
+
example:
|
3937
|
+
Cd: CCPT
|
3938
|
+
PhoneNumber:
|
3939
|
+
title: PhoneNumber
|
3940
|
+
type: string
|
3941
|
+
description: |
|
3942
|
+
Double check this regex.
|
3943
|
+
pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
|
3944
|
+
PostalAddress24:
|
3945
|
+
title: PostalAddress24
|
3946
|
+
type: object
|
3947
|
+
description: >
|
3948
|
+
Information that locates and identifies a specific address, as defined
|
3949
|
+
by postal services.
|
3950
|
+
properties:
|
3951
|
+
AdrTp:
|
3952
|
+
$ref: "#/components/schemas/AddressType3Choice"
|
3953
|
+
Dept:
|
3954
|
+
$ref: "#/components/schemas/Max70Text"
|
3955
|
+
SubDept:
|
3956
|
+
$ref: "#/components/schemas/Max70Text"
|
3957
|
+
StrtNm:
|
3958
|
+
$ref: "#/components/schemas/Max70Text"
|
3959
|
+
BldgNb:
|
3960
|
+
$ref: "#/components/schemas/Max16Text"
|
3961
|
+
BldgNm:
|
3962
|
+
$ref: "#/components/schemas/Max35Text"
|
3963
|
+
Flr:
|
3964
|
+
$ref: "#/components/schemas/Max70Text"
|
3965
|
+
PstBx:
|
3966
|
+
$ref: "#/components/schemas/Max16Text"
|
3967
|
+
Room:
|
3968
|
+
$ref: "#/components/schemas/Max70Text"
|
3969
|
+
PstCd:
|
3970
|
+
$ref: "#/components/schemas/Max16Text"
|
3971
|
+
TwnNm:
|
3972
|
+
$ref: "#/components/schemas/Max35Text"
|
3973
|
+
TwnLctnNm:
|
3974
|
+
$ref: "#/components/schemas/Max35Text"
|
3975
|
+
DstrctNm:
|
3976
|
+
$ref: "#/components/schemas/Max35Text"
|
3977
|
+
CtrySubDvsn:
|
3978
|
+
$ref: "#/components/schemas/Max35Text"
|
3979
|
+
Ctry:
|
3980
|
+
$ref: "#/components/schemas/CountryCode"
|
3981
|
+
AdrLine:
|
3982
|
+
$ref: "#/components/schemas/Max70Text"
|
3983
|
+
example:
|
3984
|
+
AdrTp: ADDR
|
3985
|
+
Dept: Dept
|
3986
|
+
SubDept: SubDept
|
3987
|
+
StrtNm: StrtNm
|
3988
|
+
BldgNb: BldgNb
|
3989
|
+
BldgNm: BldgNm
|
3990
|
+
Flr: Flr
|
3991
|
+
PstBx: PstBx
|
3992
|
+
Room: Room
|
3993
|
+
PstCd: PstCd
|
3994
|
+
TwnNm: TwnNm
|
3995
|
+
TwnLctnNm: TwnLctnNm
|
3996
|
+
DstrctNm: DstrctNm
|
3997
|
+
CtrySubDvsn: CtrySubDvsn
|
3998
|
+
Ctry: Ctry
|
3999
|
+
AdrLine: AdrLine
|
4000
|
+
PostalAddress27:
|
4001
|
+
title: PostalAddress27
|
4002
|
+
type: object
|
4003
|
+
description: >
|
4004
|
+
Information that locates and identifies a specific address, as defined
|
4005
|
+
by postal services.
|
4006
|
+
properties:
|
4007
|
+
AdrTp:
|
4008
|
+
$ref: "#/components/schemas/AddressType3Choice"
|
4009
|
+
CareOf:
|
4010
|
+
$ref: "#/components/schemas/Max140Text"
|
4011
|
+
Dept:
|
4012
|
+
$ref: "#/components/schemas/Max70Text"
|
4013
|
+
SubDept:
|
4014
|
+
$ref: "#/components/schemas/Max70Text"
|
4015
|
+
StrtNm:
|
4016
|
+
$ref: "#/components/schemas/Max140Text"
|
4017
|
+
BldgNb:
|
4018
|
+
$ref: "#/components/schemas/Max16Text"
|
4019
|
+
BldgNm:
|
4020
|
+
$ref: "#/components/schemas/Max140Text"
|
4021
|
+
Flr:
|
4022
|
+
$ref: "#/components/schemas/Max70Text"
|
4023
|
+
UnitNb:
|
4024
|
+
$ref: "#/components/schemas/Max16Text"
|
4025
|
+
PstBx:
|
4026
|
+
$ref: "#/components/schemas/Max16Text"
|
4027
|
+
Room:
|
4028
|
+
$ref: "#/components/schemas/Max70Text"
|
4029
|
+
PstCd:
|
4030
|
+
$ref: "#/components/schemas/Max16Text"
|
4031
|
+
TwnNm:
|
4032
|
+
$ref: "#/components/schemas/Max140Text"
|
4033
|
+
TwnLctnNm:
|
4034
|
+
$ref: "#/components/schemas/Max140Text"
|
4035
|
+
DstrctNm:
|
4036
|
+
$ref: "#/components/schemas/Max140Text"
|
4037
|
+
CtrySubDvsn:
|
4038
|
+
$ref: "#/components/schemas/Max35Text"
|
4039
|
+
Ctry:
|
4040
|
+
$ref: "#/components/schemas/CountryCode"
|
4041
|
+
AdrLine:
|
4042
|
+
$ref: "#/components/schemas/Max70Text"
|
4043
|
+
example:
|
4044
|
+
AdrTp: ADDR
|
4045
|
+
CareOf: CareOf
|
4046
|
+
Dept: Dept
|
4047
|
+
SubDept: SubDept
|
4048
|
+
StrtNm: StrtNm
|
4049
|
+
BldgNb: BldgNb
|
4050
|
+
BldgNm: BldgNm
|
4051
|
+
Flr: Flr
|
4052
|
+
UnitNb: UnitNb
|
4053
|
+
PstBx: PstBx
|
4054
|
+
Room: Room
|
4055
|
+
PstCd: PstCd
|
4056
|
+
TwnNm: TwnNm
|
4057
|
+
TwnLctnNm: TwnLctnNm
|
4058
|
+
DstrctNm: DstrctNm
|
4059
|
+
CtrySubDvsn: CtrySubDvsn
|
4060
|
+
Ctry: Ctry
|
4061
|
+
AdrLine: AdrLine
|
4062
|
+
PreferredContactMethod1Code:
|
4063
|
+
title: PreferredContactMethod1Code
|
4064
|
+
description: >
|
4065
|
+
Preferred method used to reach the individual contact within an
|
4066
|
+
organisation.
|
4067
|
+
type: string
|
4068
|
+
enum:
|
4069
|
+
- LETT
|
4070
|
+
- MAIL
|
4071
|
+
- PHON
|
4072
|
+
- FAXX
|
4073
|
+
- CELL
|
4074
|
+
example: CELL
|
4075
|
+
PreferredContactMethod2Code:
|
4076
|
+
title: PreferredContactMethod2Code
|
4077
|
+
description: >
|
4078
|
+
Preferred method used to reach the individual contact within an
|
4079
|
+
organisation.
|
4080
|
+
type: string
|
4081
|
+
enum:
|
4082
|
+
- LETT
|
4083
|
+
- MAIL
|
4084
|
+
- PHON
|
4085
|
+
- FAXX
|
4086
|
+
- CELL
|
4087
|
+
example: MAIL
|
4088
|
+
Priority2Code:
|
4089
|
+
title: Priority2Code
|
4090
|
+
description: >
|
4091
|
+
Indicator of the urgency or order of importance that the instructing
|
4092
|
+
party would like the instructed party to apply to the processing of the
|
4093
|
+
instruction.
|
4094
|
+
type: string
|
4095
|
+
enum:
|
4096
|
+
- HIGH
|
4097
|
+
- NORM
|
4098
|
+
example: HIGH
|
4099
|
+
ProxyAccountIdentification1:
|
4100
|
+
title: ProxyAccountIdentification1
|
4101
|
+
description: |
|
4102
|
+
Information related to a proxy identification of the account.
|
4103
|
+
type: object
|
4104
|
+
properties:
|
4105
|
+
Tp:
|
4106
|
+
$ref: "#/components/schemas/ProxyAccountType1Choice"
|
4107
|
+
Id:
|
4108
|
+
$ref: "#/components/schemas/Max2048Text"
|
4109
|
+
required:
|
4110
|
+
- Id
|
4111
|
+
example:
|
4112
|
+
Tp:
|
4113
|
+
Cd: IBAN
|
4114
|
+
Id: 123
|
4115
|
+
ProxyAccountType1Choice:
|
4116
|
+
title: ProxyAccountType1Choice
|
4117
|
+
type: object
|
4118
|
+
description: |
|
4119
|
+
NOTE: Unsure on description.
|
4120
|
+
properties:
|
4121
|
+
Cd:
|
4122
|
+
$ref: "#/components/schemas/ExternalProxyAccountType1Code"
|
4123
|
+
Prtry:
|
4124
|
+
$ref: "#/components/schemas/Max35Text"
|
4125
|
+
oneOf:
|
4126
|
+
- required:
|
4127
|
+
- Cd
|
4128
|
+
- required:
|
4129
|
+
- Prtry
|
4130
|
+
example:
|
4131
|
+
Cd: CH03
|
4132
|
+
Purpose2Choice:
|
4133
|
+
title: Purpose2Choice
|
4134
|
+
description: >
|
4135
|
+
Specifies the underlying reason for the payment transaction.
|
4136
|
+
|
4137
|
+
Usage: Purpose is used by the end-customers, that is initiating party,
|
4138
|
+
(ultimate) debtor, (ultimate) creditor to provide information concerning
|
4139
|
+
the nature of the payment. Purpose is a content element, which is not
|
4140
|
+
used for processing by any of the agents involved in the payment chain.
|
4141
|
+
type: object
|
4142
|
+
properties:
|
4143
|
+
Cd:
|
4144
|
+
$ref: "#/components/schemas/ExternalPurpose1Code"
|
4145
|
+
Prtry:
|
4146
|
+
$ref: "#/components/schemas/Max35Text"
|
4147
|
+
oneOf:
|
4148
|
+
- required:
|
4149
|
+
- Cd
|
4150
|
+
- required:
|
4151
|
+
- Prtry
|
4152
|
+
example:
|
4153
|
+
Cd: CH03
|
4154
|
+
RegulatoryAuthority2:
|
4155
|
+
title: RegulatoryAuthority2
|
4156
|
+
description: >
|
4157
|
+
Information about an entity requiring the regulatory reporting
|
4158
|
+
information.
|
4159
|
+
type: object
|
4160
|
+
properties:
|
4161
|
+
Nm:
|
4162
|
+
$ref: "#/components/schemas/Max140Text"
|
4163
|
+
Ctry:
|
4164
|
+
$ref: "#/components/schemas/CountryCode"
|
4165
|
+
example:
|
4166
|
+
Nm: Swiss National Bank
|
4167
|
+
Ctry: CH
|
4168
|
+
RegulatoryReporting3:
|
4169
|
+
title: RegulatoryReporting3
|
4170
|
+
description: |
|
4171
|
+
Information needed due to regulatory and/or statutory requirements.
|
4172
|
+
type: object
|
4173
|
+
properties:
|
4174
|
+
DbtCdtRptgInd:
|
4175
|
+
$ref: "#/components/schemas/RegulatoryReportingType1Code"
|
4176
|
+
Authrty:
|
4177
|
+
$ref: "#/components/schemas/RegulatoryAuthority2"
|
4178
|
+
Dtls:
|
4179
|
+
$ref: "#/components/schemas/StructuredRegulatoryReporting3"
|
4180
|
+
example:
|
4181
|
+
DbtCdtRptgInd: CRED
|
4182
|
+
Authrty:
|
4183
|
+
Nm: Swiss National Bank
|
4184
|
+
Ctry: CH
|
4185
|
+
Dtls:
|
4186
|
+
Cd: A1
|
4187
|
+
Inf: Mandatory regulatory information
|
4188
|
+
RegulatoryReportingType1Code:
|
4189
|
+
title: RegulatoryReportingType1Code
|
4190
|
+
description: >
|
4191
|
+
Identifies whether the regulatory reporting information applies to the
|
4192
|
+
debit side, to the credit side or to both debit and credit sides of the
|
4193
|
+
transaction.
|
4194
|
+
type: string
|
4195
|
+
enum:
|
4196
|
+
- CRED
|
4197
|
+
- DEBT
|
4198
|
+
- BOTH
|
4199
|
+
example: BOTH
|
4200
|
+
ServiceLevel8Choice:
|
4201
|
+
title: ServiceLevel8Choice
|
4202
|
+
description: |
|
4203
|
+
Details about a service level.
|
4204
|
+
type: object
|
4205
|
+
properties:
|
4206
|
+
Cd:
|
4207
|
+
$ref: "#/components/schemas/ExternalServiceLevel1Code"
|
4208
|
+
Prtry:
|
4209
|
+
$ref: "#/components/schemas/Max35Text"
|
4210
|
+
oneOf:
|
4211
|
+
- required:
|
4212
|
+
- Cd
|
4213
|
+
- required:
|
4214
|
+
- Prtry
|
4215
|
+
example:
|
4216
|
+
Cd: SEPA
|
4217
|
+
SettlementInstruction15:
|
4218
|
+
title: SettlementInstruction15
|
4219
|
+
description: |
|
4220
|
+
NOTE: Unsure on description.
|
4221
|
+
type: object
|
4222
|
+
properties:
|
4223
|
+
SttlmMtd:
|
4224
|
+
$ref: "#/components/schemas/SettlementMethod1Code"
|
4225
|
+
PmtTpInf:
|
4226
|
+
$ref: "#/components/schemas/PaymentTypeInformation28"
|
4227
|
+
required:
|
4228
|
+
- SttlmMtd
|
4229
|
+
example:
|
4230
|
+
SttlmMtd: INDA
|
4231
|
+
PmtTpInf:
|
4232
|
+
InstrPrty: NORM
|
4233
|
+
SvcLvl:
|
4234
|
+
Cd: SEPA
|
4235
|
+
LclInstrm:
|
4236
|
+
Cd: CH03
|
4237
|
+
CtgyPurp:
|
4238
|
+
Cd: SUPP
|
4239
|
+
Cdtr:
|
4240
|
+
Nm: Name
|
4241
|
+
PstlAdr:
|
4242
|
+
AdrTp: ADDR
|
4243
|
+
AdrLine: Address
|
4244
|
+
Ctry: CH
|
4245
|
+
Id:
|
4246
|
+
OrgId:
|
4247
|
+
AnyBIC: BIC
|
4248
|
+
Othr:
|
4249
|
+
Id: 123
|
4250
|
+
SchmeNm:
|
4251
|
+
Cd: IBAN
|
4252
|
+
Issr: BIC
|
4253
|
+
CtryOfRes: CH
|
4254
|
+
CtctDtls:
|
4255
|
+
Nm: Name
|
4256
|
+
PhneNb: 123
|
4257
|
+
EmailAdr: null
|
4258
|
+
SettlementMethod1Code:
|
4259
|
+
title: SettlementMethod1Code
|
4260
|
+
description: |
|
4261
|
+
Specifies the method used to settle the credit transfer instruction.
|
4262
|
+
type: string
|
4263
|
+
enum:
|
4264
|
+
- INDA
|
4265
|
+
- INGA
|
4266
|
+
- COVE
|
4267
|
+
- CLRG
|
4268
|
+
example: CLRG
|
4269
|
+
StatusReason6Choice:
|
4270
|
+
title: StatusReason6Choice
|
4271
|
+
description: |
|
4272
|
+
Unsure on description.
|
4273
|
+
type: object
|
4274
|
+
properties:
|
4275
|
+
Cd:
|
4276
|
+
$ref: "#/components/schemas/ExternalStatusReason1Code"
|
4277
|
+
Prtry:
|
4278
|
+
$ref: "#/components/schemas/Max35Text"
|
4279
|
+
oneOf:
|
4280
|
+
- required:
|
4281
|
+
- Cd
|
4282
|
+
- required:
|
4283
|
+
- Prtry
|
4284
|
+
example:
|
4285
|
+
Cd: AGNT
|
4286
|
+
StatusReasonInformation14:
|
4287
|
+
title: StatusReasonInformation14
|
4288
|
+
description: |
|
4289
|
+
Unsure on description.
|
4290
|
+
type: object
|
4291
|
+
properties:
|
4292
|
+
Orgtr:
|
4293
|
+
$ref: "#/components/schemas/PartyIdentification272"
|
4294
|
+
Rsn:
|
4295
|
+
$ref: "#/components/schemas/StatusReason6Choice"
|
4296
|
+
AddtlInf:
|
4297
|
+
$ref: "#/components/schemas/Max105Text"
|
4298
|
+
example:
|
4299
|
+
Orgtr:
|
4300
|
+
Nm: Name
|
4301
|
+
PstlAdr:
|
4302
|
+
AdrTp: ADDR
|
4303
|
+
Dept: Department
|
4304
|
+
SubDept: SubDepartment
|
4305
|
+
StrtNm: StreetName
|
4306
|
+
BldgNb: BuildingNumber
|
4307
|
+
PstCd: PostCode
|
4308
|
+
TwnNm: TownName
|
4309
|
+
CtrySubDvsn: CountrySubDivision
|
4310
|
+
Ctry: Country
|
4311
|
+
Rsn:
|
4312
|
+
Cd: AGNT
|
4313
|
+
AddtlInf: AdditionalInformation
|
4314
|
+
StructuredRegulatoryReporting3:
|
4315
|
+
title: StructuredRegulatoryReporting3
|
4316
|
+
description: |
|
4317
|
+
Unsure on description.
|
4318
|
+
type: object
|
4319
|
+
properties:
|
4320
|
+
Tp:
|
4321
|
+
$ref: "#/components/schemas/Max35Text"
|
4322
|
+
Dt:
|
4323
|
+
$ref: "#/components/schemas/ISODate"
|
4324
|
+
Ctry:
|
4325
|
+
$ref: "#/components/schemas/CountryCode"
|
4326
|
+
Cd:
|
4327
|
+
$ref: "#/components/schemas/Max10Text"
|
4328
|
+
Amt:
|
4329
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
4330
|
+
Inf:
|
4331
|
+
$ref: "#/components/schemas/Max35Text"
|
4332
|
+
example:
|
4333
|
+
Tp: T1
|
4334
|
+
Dt: "2018-01-01"
|
4335
|
+
Ctry: CH
|
4336
|
+
Cd: CHF
|
4337
|
+
Amt:
|
4338
|
+
Ccy: CHF
|
4339
|
+
Amt: 1000
|
4340
|
+
Inf: 12345
|
4341
|
+
SupplementaryData1:
|
4342
|
+
title: SupplementaryData1
|
4343
|
+
description: >
|
4344
|
+
Additional information that can not be captured in the structured fields
|
4345
|
+
and/or any other specific block.
|
4346
|
+
type: object
|
4347
|
+
properties:
|
4348
|
+
PlcAndNm:
|
4349
|
+
$ref: "#/components/schemas/Max350Text"
|
4350
|
+
Envlp:
|
4351
|
+
$ref: "#/components/schemas/SupplementaryDataEnvelope1"
|
4352
|
+
required:
|
4353
|
+
- Envlp
|
4354
|
+
example:
|
4355
|
+
PlcAndNm: Additional information
|
4356
|
+
Envlp:
|
4357
|
+
Cd: CH03
|
4358
|
+
Prtry: Additional information
|
4359
|
+
SupplementaryDataEnvelope1:
|
4360
|
+
title: SupplementaryDataEnvelope1
|
4361
|
+
description: |
|
4362
|
+
Unsure on description.
|
4363
|
+
type: object
|
4364
|
+
TaxAmount3:
|
4365
|
+
title: TaxAmount3
|
4366
|
+
description: |
|
4367
|
+
Information on the amount of the tax record.
|
4368
|
+
type: object
|
4369
|
+
properties:
|
4370
|
+
Rate:
|
4371
|
+
$ref: "#/components/schemas/PercentageRate"
|
4372
|
+
TaxblBaseAmt:
|
4373
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
4374
|
+
TtlAmt:
|
4375
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
4376
|
+
Dtls:
|
4377
|
+
$ref: "#/components/schemas/TaxRecordDetails3"
|
4378
|
+
example:
|
4379
|
+
Rate: 0
|
4380
|
+
TaxblBaseAmt:
|
4381
|
+
Ccy: EUR
|
4382
|
+
Amt: 0
|
4383
|
+
TtlAmt:
|
4384
|
+
Ccy: EUR
|
4385
|
+
Amt: 0
|
4386
|
+
Dtls:
|
4387
|
+
Tp: T1
|
4388
|
+
Ctry: CH
|
4389
|
+
Cd: CHF
|
4390
|
+
Amt:
|
4391
|
+
Ccy: CHF
|
4392
|
+
Amt: 1000
|
4393
|
+
Inf: 12345
|
4394
|
+
TaxAuthorisation1:
|
4395
|
+
title: TaxAuthorisation1
|
4396
|
+
description: |
|
4397
|
+
Details of an authorised tax paying party.
|
4398
|
+
type: object
|
4399
|
+
properties:
|
4400
|
+
Titl:
|
4401
|
+
$ref: "#/components/schemas/Max35Text"
|
4402
|
+
Nm:
|
4403
|
+
$ref: "#/components/schemas/Max140Text"
|
4404
|
+
example:
|
4405
|
+
Titl: Mr
|
4406
|
+
Nm: John Doe
|
4407
|
+
TaxData1:
|
4408
|
+
title: TaxData1
|
4409
|
+
description: >
|
4410
|
+
Details about tax paid, or to be paid, to the government in accordance
|
4411
|
+
with the law, including pre-defined parameters such as thresholds and
|
4412
|
+
type of account.
|
4413
|
+
type: object
|
4414
|
+
properties:
|
4415
|
+
Cdtr:
|
4416
|
+
$ref: "#/components/schemas/TaxParty1"
|
4417
|
+
Dbtr:
|
4418
|
+
$ref: "#/components/schemas/TaxParty2"
|
4419
|
+
UltmtDbtr:
|
4420
|
+
$ref: "#/components/schemas/TaxParty2"
|
4421
|
+
AdmstnZone:
|
4422
|
+
$ref: "#/components/schemas/Max35Text"
|
4423
|
+
RefNb:
|
4424
|
+
$ref: "#/components/schemas/Max140Text"
|
4425
|
+
Mtd:
|
4426
|
+
$ref: "#/components/schemas/Max35Text"
|
4427
|
+
TtlTaxblBaseAmt:
|
4428
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
4429
|
+
TtlTaxAmt:
|
4430
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
4431
|
+
Dt:
|
4432
|
+
$ref: "#/components/schemas/ISODate"
|
4433
|
+
SeqNb:
|
4434
|
+
$ref: "#/components/schemas/Number"
|
4435
|
+
Rcrd:
|
4436
|
+
$ref: "#/components/schemas/TaxRecord3"
|
4437
|
+
example:
|
4438
|
+
Cdtr:
|
4439
|
+
Titl: Mr
|
4440
|
+
Nm: John Doe
|
4441
|
+
Dbtr:
|
4442
|
+
Titl: Mr
|
4443
|
+
Nm: John Doe
|
4444
|
+
UltmtDbtr:
|
4445
|
+
Titl: Mr
|
4446
|
+
Nm: John Doe
|
4447
|
+
AdmstnZone: CH
|
4448
|
+
RefNb: 12345
|
4449
|
+
Mtd: A
|
4450
|
+
TtlTaxblBaseAmt:
|
4451
|
+
Ccy: CHF
|
4452
|
+
Amt: 1000
|
4453
|
+
TtlTaxAmt:
|
4454
|
+
Ccy: CHF
|
4455
|
+
Amt: 100
|
4456
|
+
Dt: "2018-01-01"
|
4457
|
+
SeqNb: 1
|
4458
|
+
Rcrd:
|
4459
|
+
Tp: T1
|
4460
|
+
Ctry: CH
|
4461
|
+
Cd: CHF
|
4462
|
+
Amt:
|
4463
|
+
Ccy: CHF
|
4464
|
+
Amt: 1000
|
4465
|
+
Inf: 12345
|
4466
|
+
TaxParty1:
|
4467
|
+
title: TaxParty1
|
4468
|
+
description: |
|
4469
|
+
Details about the entity involved in the tax paid or to be paid.
|
4470
|
+
type: object
|
4471
|
+
properties:
|
4472
|
+
TaxId:
|
4473
|
+
$ref: "#/components/schemas/Max35Text"
|
4474
|
+
RegnId:
|
4475
|
+
$ref: "#/components/schemas/Max35Text"
|
4476
|
+
TaxTp:
|
4477
|
+
$ref: "#/components/schemas/Max35Text"
|
4478
|
+
example:
|
4479
|
+
TaxId: 123456789
|
4480
|
+
RegnId: 123456789
|
4481
|
+
TaxTp: VAT
|
4482
|
+
TaxParty2:
|
4483
|
+
title: TaxParty2
|
4484
|
+
description: |
|
4485
|
+
Details about the entity involved in the tax paid or to be paid.
|
4486
|
+
type: object
|
4487
|
+
properties:
|
4488
|
+
TaxId:
|
4489
|
+
$ref: "#/components/schemas/Max35Text"
|
4490
|
+
RegnId:
|
4491
|
+
$ref: "#/components/schemas/Max35Text"
|
4492
|
+
TaxTp:
|
4493
|
+
$ref: "#/components/schemas/Max35Text"
|
4494
|
+
Authstn:
|
4495
|
+
$ref: "#/components/schemas/TaxAuthorisation1"
|
4496
|
+
example:
|
4497
|
+
TaxId: 123456789
|
4498
|
+
RegnId: 123456789
|
4499
|
+
TaxTp: VAT
|
4500
|
+
Authstn:
|
4501
|
+
Titl: Mr
|
4502
|
+
Nm: John Doe
|
4503
|
+
TaxPeriod3:
|
4504
|
+
title: TaxPeriod3
|
4505
|
+
description: |
|
4506
|
+
Period of time details related to the tax payment.
|
4507
|
+
type: object
|
4508
|
+
properties:
|
4509
|
+
Yr:
|
4510
|
+
$ref: "#/components/schemas/ISOYear"
|
4511
|
+
Tp:
|
4512
|
+
$ref: "#/components/schemas/TaxRecordPeriod1Code"
|
4513
|
+
FrToDt:
|
4514
|
+
$ref: "#/components/schemas/DatePeriod2"
|
4515
|
+
example:
|
4516
|
+
Yr: 2020
|
4517
|
+
Tp: MM01
|
4518
|
+
FrToDt:
|
4519
|
+
FrDt: "2020-01-01"
|
4520
|
+
ToDt: "2020-01-31"
|
4521
|
+
TaxRecord3:
|
4522
|
+
title: TaxRecord3
|
4523
|
+
description: |
|
4524
|
+
Set of elements used to define the tax record.
|
4525
|
+
type: object
|
4526
|
+
properties:
|
4527
|
+
Tp:
|
4528
|
+
$ref: "#/components/schemas/Max35Text"
|
4529
|
+
Ctgy:
|
4530
|
+
$ref: "#/components/schemas/Max35Text"
|
4531
|
+
CtgyDtls:
|
4532
|
+
$ref: "#/components/schemas/Max35Text"
|
4533
|
+
DbtrSts:
|
4534
|
+
$ref: "#/components/schemas/Max35Text"
|
4535
|
+
CertId:
|
4536
|
+
$ref: "#/components/schemas/Max35Text"
|
4537
|
+
FrmsCd:
|
4538
|
+
$ref: "#/components/schemas/Max35Text"
|
4539
|
+
Prd:
|
4540
|
+
$ref: "#/components/schemas/TaxPeriod3"
|
4541
|
+
TaxAmt:
|
4542
|
+
$ref: "#/components/schemas/TaxAmount3"
|
4543
|
+
AddtlInf:
|
4544
|
+
$ref: "#/components/schemas/Max140Text"
|
4545
|
+
example:
|
4546
|
+
Tp: VAT
|
4547
|
+
Ctgy: A
|
4548
|
+
CtgyDtls: Standard
|
4549
|
+
DbtrSts: Resident
|
4550
|
+
CertId: 123456789
|
4551
|
+
FrmsCd: 123456789
|
4552
|
+
Prd:
|
4553
|
+
FrstDay: "2019-01-01"
|
4554
|
+
LastDay: "2019-12-31"
|
4555
|
+
TaxAmt:
|
4556
|
+
Rate: 0.2
|
4557
|
+
TaxblBaseAmt: 1000
|
4558
|
+
TtlAmt: 200
|
4559
|
+
AddtlInf: VAT applicable
|
4560
|
+
TaxRecordDetails3:
|
4561
|
+
title: TaxRecordDetails3
|
4562
|
+
description: |
|
4563
|
+
Details on the tax period and amount
|
4564
|
+
type: object
|
4565
|
+
properties:
|
4566
|
+
Prd:
|
4567
|
+
$ref: "#/components/schemas/TaxPeriod3"
|
4568
|
+
Amt:
|
4569
|
+
$ref: "#/components/schemas/ActiveOrHistoricCurrencyAndAmount"
|
4570
|
+
required:
|
4571
|
+
- Amt
|
4572
|
+
example:
|
4573
|
+
Prd:
|
4574
|
+
Yr: 2020
|
4575
|
+
Tp: MM01
|
4576
|
+
FrToDt:
|
4577
|
+
FrDt: "2020-01-01"
|
4578
|
+
ToDt: "2020-01-31"
|
4579
|
+
Amt:
|
4580
|
+
Amt: 100
|
4581
|
+
Ccy: EUR
|
4582
|
+
TaxRecordPeriod1Code:
|
4583
|
+
title: TaxRecordPeriod1Code
|
4584
|
+
description: |
|
4585
|
+
Specifies the period related to the tax payment
|
4586
|
+
|
4587
|
+
MM01 FirstMonth Tax is related to the second month of the period.
|
4588
|
+
MM02 SecondMonth Tax is related to the first month of the period.
|
4589
|
+
MM03 ThirdMonth Tax is related to the third month of the period.
|
4590
|
+
MM04 FourthMonth Tax is related to the fourth month of the period.
|
4591
|
+
MM05 FifthMonth Tax is related to the fifth month of the period.
|
4592
|
+
MM06 SixthMonth Tax is related to the sixth month of the period.
|
4593
|
+
MM07 SeventhMonth Tax is related to the seventh month of the period.
|
4594
|
+
MM08 EighthMonth Tax is related to the eighth month of the period.
|
4595
|
+
MM09 NinthMonth Tax is related to the ninth month of the period.
|
4596
|
+
MM10 TenthMonth Tax is related to the tenth month of the period.
|
4597
|
+
MM11 EleventhMonth Tax is related to the eleventh month of the period.
|
4598
|
+
MM12 TwelfthMonth Tax is related to the twelfth month of the period.
|
4599
|
+
QTR1 FirstQuarter Tax is related to the first quarter of the period.
|
4600
|
+
QTR2 SecondQuarter Tax is related to the second quarter of the period.
|
4601
|
+
QTR3 ThirdQuarter Tax is related to the third quarter of the period.
|
4602
|
+
QTR4 FourthQuarter Tax is related to the forth quarter of the period.
|
4603
|
+
HLF1 FirstHalf Tax is related to the first half of the period.
|
4604
|
+
HLF2 SecondHalf Tax is related to the second half of the period.
|
4605
|
+
type: string
|
4606
|
+
enum:
|
4607
|
+
- MM01
|
4608
|
+
- MM02
|
4609
|
+
- MM03
|
4610
|
+
- MM04
|
4611
|
+
- MM05
|
4612
|
+
- MM06
|
4613
|
+
- MM07
|
4614
|
+
- MM08
|
4615
|
+
- MM09
|
4616
|
+
- MM10
|
4617
|
+
- MM11
|
4618
|
+
- MM12
|
4619
|
+
- QTR1
|
4620
|
+
- QTR2
|
4621
|
+
- QTR3
|
4622
|
+
- QTR4
|
4623
|
+
- HLF1
|
4624
|
+
- HLF2
|
4625
|
+
example: HLF1
|
4626
|
+
TermsRequest_FIToFICustomerCreditProposal:
|
4627
|
+
title: TermsRequest_FIToFICustomerCreditProposal
|
4628
|
+
type: object
|
4629
|
+
properties:
|
4630
|
+
GrpHdr:
|
4631
|
+
$ref: "#/components/schemas/GroupHeader129"
|
4632
|
+
required:
|
4633
|
+
- GrpHdr
|
4634
|
+
example:
|
4635
|
+
GrpHdr:
|
4636
|
+
MsgId: 123456789
|
4637
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
4638
|
+
NbOfTxs: 1
|
4639
|
+
CtrlSum: 100
|
4640
|
+
InitgPty:
|
4641
|
+
Nm: Initiating Party Name
|
4642
|
+
Id:
|
4643
|
+
OrgId:
|
4644
|
+
Othr:
|
4645
|
+
- Id: 123456789
|
4646
|
+
SchmeNm:
|
4647
|
+
Cd: BBA
|
4648
|
+
Prtry: Party Identification Scheme Name
|
4649
|
+
FwdgAgt:
|
4650
|
+
FinInstnId:
|
4651
|
+
BICFI: BBBBBBBB
|
4652
|
+
TermsResponse_FIToFICustomerCreditConfirmation:
|
4653
|
+
title: TermsResponse_FIToFICustomerCreditConfirmation
|
4654
|
+
type: object
|
4655
|
+
properties:
|
4656
|
+
GrpHdr:
|
4657
|
+
$ref: "#/components/schemas/GroupHeader129"
|
4658
|
+
CdtTrfTxInf:
|
4659
|
+
$ref: "#/components/schemas/CreditTransferTransaction67"
|
4660
|
+
required:
|
4661
|
+
- GrpHdr
|
4662
|
+
- CdtTrfTxInf
|
4663
|
+
example:
|
4664
|
+
GrpHdr:
|
4665
|
+
MsgId: 123456789
|
4666
|
+
CreDtTm: "2020-01-01T00:00:00Z"
|
4667
|
+
NbOfTxs: 1
|
4668
|
+
CtrlSum: 100
|
4669
|
+
InitgPty:
|
4670
|
+
Nm: Initiating Party Name
|
4671
|
+
Id:
|
4672
|
+
OrgId:
|
4673
|
+
Othr:
|
4674
|
+
- Id: 123456789
|
4675
|
+
SchmeNm:
|
4676
|
+
Cd: BBA
|
4677
|
+
Prtry: Party Identification Scheme Name
|
4678
|
+
FwdgAgt:
|
4679
|
+
FinInstnId:
|
4680
|
+
BICFI: BBBBBBBB
|
4681
|
+
UUIDv4Identifier:
|
4682
|
+
title: UUIDv4Identifier
|
4683
|
+
type: string
|
4684
|
+
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
|
4685
|
+
example: 8f3a3b2d-3b0a-4b3f-8e4e-1b2f3f4c5d6e
|
4686
|
+
VerificationReason1Choice:
|
4687
|
+
title: VerificationReason1Choice
|
4688
|
+
type: object
|
4689
|
+
properties:
|
4690
|
+
Cd:
|
4691
|
+
$ref: "#/components/schemas/ExternalVerificationReason1Code"
|
4692
|
+
Prtry:
|
4693
|
+
$ref: "#/components/schemas/Max35Text"
|
4694
|
+
oneOf:
|
4695
|
+
- required:
|
4696
|
+
- Cd
|
4697
|
+
- required:
|
4698
|
+
- Prtry
|
4699
|
+
example:
|
4700
|
+
Cd: AGNT
|
4701
|
+
VerificationReport4:
|
4702
|
+
title: VerificationReport4
|
4703
|
+
type: object
|
4704
|
+
properties:
|
4705
|
+
OrgnlId:
|
4706
|
+
$ref: "#/components/schemas/Max35Text"
|
4707
|
+
Vrfctn:
|
4708
|
+
$ref: "#/components/schemas/IdentificationVerificationIndicator"
|
4709
|
+
Rsn:
|
4710
|
+
$ref: "#/components/schemas/VerificationReason1Choice"
|
4711
|
+
OrgnlPtyAndAcctId:
|
4712
|
+
$ref: "#/components/schemas/IdentificationInformation4"
|
4713
|
+
UpdtdPtyAndAcctId:
|
4714
|
+
$ref: "#/components/schemas/IdentificationInformation4"
|
4715
|
+
required:
|
4716
|
+
- OrgnlId
|
4717
|
+
- Vrfctn
|
4718
|
+
example:
|
4719
|
+
OrgnlId: 123456789
|
4720
|
+
Vrfctn: true
|
4721
|
+
Rsn:
|
4722
|
+
Cd: AGNT
|
4723
|
+
OrgnlPtyAndAcctId:
|
4724
|
+
Id: 123456789
|
4725
|
+
SchmeNm:
|
4726
|
+
Cd: CCPT
|
4727
|
+
UpdtdPtyAndAcctId:
|
4728
|
+
Id: 123456789
|
4729
|
+
SchmeNm:
|
4730
|
+
Cd: CCPT
|
4731
|
+
hexBinary:
|
4732
|
+
title: hexBinary
|
4733
|
+
type: string
|
4734
|
+
pattern: ^(0x|0X)?[a-fA-F0-9]+$
|
4735
|
+
example: 4660
|