From bf4adba8c5d3fa5655e29e4cd9ab1fda2f00117c Mon Sep 17 00:00:00 2001 From: Zoltan Giber Date: Tue, 16 Feb 2021 17:25:51 +0000 Subject: [PATCH] generated diagrams --- gen-diagrams.sh | 87 + uml-diagrams/OBBCAData1.svg | 2179 +++++ uml-diagrams/OBFundsConfirmation1.svg | 78 + uml-diagrams/OBFundsConfirmationConsent1.svg | 97 + .../OBFundsConfirmationConsentResponse1.svg | 220 + uml-diagrams/OBFundsConfirmationResponse1.svg | 186 + uml-diagrams/OBPCAData1.svg | 2094 ++++ uml-diagrams/OBParty2.svg | 265 + uml-diagrams/OBReadAccount6.svg | 328 + uml-diagrams/OBReadBalance1.svg | 260 + uml-diagrams/OBReadBeneficiary5.svg | 367 + uml-diagrams/OBReadConsent1.svg | 82 + uml-diagrams/OBReadConsentResponse1.svg | 205 + uml-diagrams/OBReadDirectDebit2.svg | 224 + uml-diagrams/OBReadOffer1.svg | 271 + uml-diagrams/OBReadParty2.svg | 367 + uml-diagrams/OBReadParty3.svg | 367 + uml-diagrams/OBReadProduct2.svg | 8378 +++++++++++++++++ uml-diagrams/OBReadScheduledPayment3.svg | 292 + uml-diagrams/OBReadStandingOrder6.svg | 448 + uml-diagrams/OBReadTransaction6.svg | 962 ++ uml-diagrams/OBRisk1.svg | 123 + uml-diagrams/OBSCASupportData1.svg | 60 + uml-diagrams/OBWriteDomestic2.svg | 479 + uml-diagrams/OBWriteDomesticConsent4.svg | 556 ++ .../OBWriteDomesticConsentResponse5.svg | 804 ++ uml-diagrams/OBWriteDomesticResponse5.svg | 728 ++ uml-diagrams/OBWriteDomesticScheduled2.svg | 490 + .../OBWriteDomesticScheduledConsent4.svg | 576 ++ ...WriteDomesticScheduledConsentResponse5.svg | 824 ++ .../OBWriteDomesticScheduledResponse5.svg | 737 ++ .../OBWriteDomesticStandingOrder3.svg | 439 + .../OBWriteDomesticStandingOrderConsent5.svg | 525 ++ ...eDomesticStandingOrderConsentResponse6.svg | 753 ++ .../OBWriteDomesticStandingOrderResponse6.svg | 666 ++ uml-diagrams/OBWriteFile2.svg | 221 + uml-diagrams/OBWriteFileConsent3.svg | 288 + uml-diagrams/OBWriteFileConsentResponse4.svg | 517 + uml-diagrams/OBWriteFileResponse3.svg | 493 + .../OBWriteFundsConfirmationResponse1.svg | 153 + uml-diagrams/OBWriteInternational3.svg | 740 ++ uml-diagrams/OBWriteInternationalConsent5.svg | 817 ++ .../OBWriteInternationalConsentResponse6.svg | 1120 +++ .../OBWriteInternationalResponse5.svg | 1304 +++ .../OBWriteInternationalScheduled3.svg | 751 ++ .../OBWriteInternationalScheduledConsent5.svg | 837 ++ ...InternationalScheduledConsentResponse6.svg | 1140 +++ ...OBWriteInternationalScheduledResponse6.svg | 1313 +++ .../OBWriteInternationalStandingOrder4.svg | 686 ++ ...riteInternationalStandingOrderConsent6.svg | 772 ++ ...rnationalStandingOrderConsentResponse7.svg | 1000 ++ ...iteInternationalStandingOrderResponse7.svg | 1173 +++ .../OBWritePaymentDetailsResponse1.svg | 237 + 53 files changed, 39079 insertions(+) create mode 100755 gen-diagrams.sh create mode 100644 uml-diagrams/OBBCAData1.svg create mode 100644 uml-diagrams/OBFundsConfirmation1.svg create mode 100644 uml-diagrams/OBFundsConfirmationConsent1.svg create mode 100644 uml-diagrams/OBFundsConfirmationConsentResponse1.svg create mode 100644 uml-diagrams/OBFundsConfirmationResponse1.svg create mode 100644 uml-diagrams/OBPCAData1.svg create mode 100644 uml-diagrams/OBParty2.svg create mode 100644 uml-diagrams/OBReadAccount6.svg create mode 100644 uml-diagrams/OBReadBalance1.svg create mode 100644 uml-diagrams/OBReadBeneficiary5.svg create mode 100644 uml-diagrams/OBReadConsent1.svg create mode 100644 uml-diagrams/OBReadConsentResponse1.svg create mode 100644 uml-diagrams/OBReadDirectDebit2.svg create mode 100644 uml-diagrams/OBReadOffer1.svg create mode 100644 uml-diagrams/OBReadParty2.svg create mode 100644 uml-diagrams/OBReadParty3.svg create mode 100644 uml-diagrams/OBReadProduct2.svg create mode 100644 uml-diagrams/OBReadScheduledPayment3.svg create mode 100644 uml-diagrams/OBReadStandingOrder6.svg create mode 100644 uml-diagrams/OBReadTransaction6.svg create mode 100644 uml-diagrams/OBRisk1.svg create mode 100644 uml-diagrams/OBSCASupportData1.svg create mode 100644 uml-diagrams/OBWriteDomestic2.svg create mode 100644 uml-diagrams/OBWriteDomesticConsent4.svg create mode 100644 uml-diagrams/OBWriteDomesticConsentResponse5.svg create mode 100644 uml-diagrams/OBWriteDomesticResponse5.svg create mode 100644 uml-diagrams/OBWriteDomesticScheduled2.svg create mode 100644 uml-diagrams/OBWriteDomesticScheduledConsent4.svg create mode 100644 uml-diagrams/OBWriteDomesticScheduledConsentResponse5.svg create mode 100644 uml-diagrams/OBWriteDomesticScheduledResponse5.svg create mode 100644 uml-diagrams/OBWriteDomesticStandingOrder3.svg create mode 100644 uml-diagrams/OBWriteDomesticStandingOrderConsent5.svg create mode 100644 uml-diagrams/OBWriteDomesticStandingOrderConsentResponse6.svg create mode 100644 uml-diagrams/OBWriteDomesticStandingOrderResponse6.svg create mode 100644 uml-diagrams/OBWriteFile2.svg create mode 100644 uml-diagrams/OBWriteFileConsent3.svg create mode 100644 uml-diagrams/OBWriteFileConsentResponse4.svg create mode 100644 uml-diagrams/OBWriteFileResponse3.svg create mode 100644 uml-diagrams/OBWriteFundsConfirmationResponse1.svg create mode 100644 uml-diagrams/OBWriteInternational3.svg create mode 100644 uml-diagrams/OBWriteInternationalConsent5.svg create mode 100644 uml-diagrams/OBWriteInternationalConsentResponse6.svg create mode 100644 uml-diagrams/OBWriteInternationalResponse5.svg create mode 100644 uml-diagrams/OBWriteInternationalScheduled3.svg create mode 100644 uml-diagrams/OBWriteInternationalScheduledConsent5.svg create mode 100644 uml-diagrams/OBWriteInternationalScheduledConsentResponse6.svg create mode 100644 uml-diagrams/OBWriteInternationalScheduledResponse6.svg create mode 100644 uml-diagrams/OBWriteInternationalStandingOrder4.svg create mode 100644 uml-diagrams/OBWriteInternationalStandingOrderConsent6.svg create mode 100644 uml-diagrams/OBWriteInternationalStandingOrderConsentResponse7.svg create mode 100644 uml-diagrams/OBWriteInternationalStandingOrderResponse7.svg create mode 100644 uml-diagrams/OBWritePaymentDetailsResponse1.svg diff --git a/gen-diagrams.sh b/gen-diagrams.sh new file mode 100755 index 00000000..d76ae20a --- /dev/null +++ b/gen-diagrams.sh @@ -0,0 +1,87 @@ +#!/usr/bin/env bash + +# install umldiagram from https://bitbucket.org/openbankingteam/uml-generator/src/master/ +umldiagram --src=./dist/swagger/account-info-swagger.yaml --dir=uml-diagrams\ + --schema=OBReadConsent1\ + --schema=OBReadConsentResponse1\ + --schema=OBReadAccount6\ + --schema=OBReadBalance1\ + --schema=OBReadTransaction6\ + --schema=OBReadBeneficiary5\ + --schema=OBReadDirectDebit2\ + --schema=OBReadStandingOrder6\ + --schema=OBReadProduct2\ + --schema=OBBCAData1\ + --schema=OBBCAData1\ + --schema=OBPCAData1\ + --schema=OBReadOffer1\ + --schema=OBParty2\ + --schema=OBReadParty2\ + --schema=OBReadParty3\ + --schema=OBReadScheduledPayment3\ + --schema=OBBCAData1.properties.Overdraft\ + # --schema=OBBCAData1.OtherFeesCharges\ # fix nested objects + # --schema=Overdraft.OverdraftTierBandSet\ # fix nested objects + # --schema=LoanInterest\ + # --schema=Repayment\ + +umldiagram --src=./dist/swagger/payment-initiation-swagger.yaml --dir=uml-diagrams\ + --schema=OBRisk1\ + --schema=OBSCASupportData1\ + --schema=OBWriteFundsConfirmationResponse1\ + --schema=OBWriteDomestic2\ + --schema=OBWriteDomesticConsent4\ + --schema=OBWriteDomesticConsentResponse5\ + --schema=OBWriteDomesticResponse5\ + --schema=OBWritePaymentDetailsResponse1\ + --schema=OBWriteDomesticScheduledConsent4\ + --schema=OBWriteDomesticScheduledConsentResponse5\ + --schema=OBWriteDomesticScheduled2\ + --schema=OBWriteDomesticScheduledResponse5\ + --schema=OBWritePaymentDetailsResponse1\ + --schema=OBWriteDomesticStandingOrderConsent5\ + --schema=OBWriteDomesticStandingOrderConsentResponse6\ + --schema=OBWriteDomesticStandingOrder3\ + --schema=OBWriteDomesticStandingOrderResponse6\ + --schema=OBWritePaymentDetailsResponse1\ + --schema=OBWriteInternationalConsent5\ + --schema=OBWriteInternationalConsentResponse6\ + --schema=OBWriteFundsConfirmationResponse1\ + --schema=OBWriteInternational3\ + --schema=OBWriteInternationalResponse5\ + --schema=OBWritePaymentDetailsResponse1\ + --schema=OBWriteInternationalScheduledConsent5\ + --schema=OBWriteInternationalScheduledConsentResponse6\ + --schema=OBWriteFundsConfirmationResponse1\ + --schema=OBWriteInternationalScheduled3\ + --schema=OBWriteInternationalScheduledResponse6\ + --schema=OBWritePaymentDetailsResponse1\ + --schema=OBWriteInternationalStandingOrderConsent6\ + --schema=OBWriteInternationalStandingOrderConsentResponse7\ + --schema=OBWriteInternationalStandingOrder4\ + --schema=OBWriteInternationalStandingOrderResponse7\ + --schema=OBWritePaymentDetailsResponse1\ + --schema=OBWriteFileConsent3\ + --schema=OBWriteFileConsentResponse4\ + --schema=OBWriteFile2\ + --schema=OBWriteFileResponse3\ + --schema=OBWritePaymentDetailsResponse1\ + # --schema=OBWritePaymentDetails1\ + # --schema=OBDomesticRefundAccount1\ + # --schema=OBInternationalRefundAccount1\ + # --schema=OBDomesticScheduled2\ + # --schema=OBDomesticStandingOrder3\ + # --schema=OBInternational3\ + # --schema=OBExchangeRate2\ + # --schema=OBInternationalScheduled3\ + # --schema=OBInternationalStandingOrder4\ + # --schema=OBFile2\ + # --schema=OBAuthorisation1\ + # --schema=OBMultiAuthorisation1\ + # --schema=OBDomestic2\ + +umldiagram --src=./dist/swagger/confirmation-funds-swagger.yaml --dir=uml-diagrams\ + --schema=OBFundsConfirmationConsent1\ + --schema=OBFundsConfirmationConsentResponse1\ + --schema=OBFundsConfirmation1\ + --schema=OBFundsConfirmationResponse1\ diff --git a/uml-diagrams/OBBCAData1.svg b/uml-diagrams/OBBCAData1.svg new file mode 100644 index 00000000..bfd858f4 --- /dev/null +++ b/uml-diagrams/OBBCAData1.svg @@ -0,0 +1,2179 @@ + + + + + + + + + + + + + +OBBCAData1 + + + + +Details about the interest that may be payable to the BCA account holders +CreditInterest + + + + +The group of tiers or bands for which credit interest can be applied. +TierBandSet + + + +Type: string +Description: Methods of calculating interest +Values: + - Compound + - SimpleInterest + +CalculationMethod [0..1] + + + +Type: string +Description: Describes whether accrued interest is payable only to the BCA or to another bank account +Values: + - PayAway + - SelfCredit + +Destination [1..1] + + + + +Notes [0..*] + + + +Type: string +Description: The methodology of how credit interest is paid/applied. It can be:- + +1. Banded +Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. + +2. Tiered +Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. + +3. Whole +The same interest rate is applied irrespective of the BCA balance +Values: + - Banded + - Tiered + - Whole + +TierBandMethod [1..1] + + + + +Tier Band Details +TierBand + + + +Type: string +Description: The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. + +Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +AER [1..1] + + + +Type: string +Description: How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA. +Values: + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: Bank Interest for the BCA product +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +BankInterestRate [0..1] + + + +Type: string +Description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA. +Values: + - Gross + - Other + +BankInterestRateType [0..1] + + + +Type: string +Description: How often is credit interest calculated for the account. +Values: + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount on which Interest applied. +Values: + - Banded + - Tiered + - Whole + +DepositInterestAppliedCoverage [0..1] + + + +Type: string +Description: Type of interest rate, Fixed or Variable +Values: + - Fixed + - Variable + +FixedVariableInterestRateType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a BCA. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Maximum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMaximum [0..1] + + + +Type: string +Description: Minimum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMinimum [1..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other interest rate types which are not available in the standard code list +OtherBankInterestType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Contains details of fees and charges which are not associated with either Overdraft or features/benefits +OtherFeesCharges + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the tariff + +TariffName [0..1] + + + +Type: string +Description: TariffType which defines the fee and charges. +Values: + - Electronic + - Mixed + - Other + +TariffType [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular or group of fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +FeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - Gross + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - Other + - ServiceCAccountFee + - ServiceCAccountFeeMonthly + - ServiceCAccountFeeQuarterly + - ServiceCFixedTariff + - ServiceCBusiDepAccBreakage + - ServiceCMinimumMonthlyFee + - ServiceCOther + +FeeType [1..1] + + + +Type: boolean +Description: Fee/charge which is usually negotiable rather than a fixed amount + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + + +Range or amounts or rates for which the fee/charge applies +FeeApplicableRange + + + +Type: string +Description: Maximum Amount on which fee is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MaximumAmount [0..1] + + + +Type: string +Description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MaximumRate [0..1] + + + +Type: string +Description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MinimumAmount [0..1] + + + +Type: string +Description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MinimumRate [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular or group of fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherFeeCategoryType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other tariff type which is not in the standard list. +OtherTariffType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Borrowing details +Overdraft + + + + +Notes [0..*] + + + + +Tier band set details +OverdraftTierBandSet + + + +Type: boolean +Description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) + +AuthorisedIndicator [0..1] + + + +Type: string +Description: When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +BufferAmount [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft product. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. +Values: + - Committed + - OnDemand + +OverdraftType [0..1] + + + +Type: string +Description: The methodology of how overdraft is charged. It can be: +'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). +'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation +'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. +Values: + - Banded + - Tiered + - Whole + +TierBandMethod [1..1] + + + + +Overdraft fees and charges details +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - Gross + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - AnnualReview + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + +Type: boolean +Description: Indicates whether fee and charges are negotiable + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Provides overdraft details for a specific tier or band +OverdraftTierBand + + + +Type: number +Format: float +Description: Specifies the maximum length of a band for a fixed overdraft agreement + +AgreementLengthMax [0..1] + + + +Type: number +Format: float +Description: Specifies the minimum length of a band for a fixed overdraft agreement + +AgreementLengthMin [0..1] + + + +Type: string +Description: Specifies the period of a fixed length overdraft agreement +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +AgreementPeriod [0..1] + + + +Type: boolean +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +BankGuaranteedIndicator [0..1] + + + +Type: string +Description: EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently +used interchangeably), being the actual annual interest rate of an Overdraft. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +EAR [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’. +Values: + - Banded + - Tiered + - Whole + +OverdraftInterestChargingCoverage [0..1] + + + +Type: string +Description: An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +RepresentativeAPR [0..1] + + + +Type: string +Description: Maximum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMax [0..1] + + + +Type: string +Description: Minimum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMin [1..1] + + + + +Overdraft fees and charges +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - Gross + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - AnnualReview + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + +Type: boolean +Description: Indicates whether fee and charges are negotiable + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +ProductDetails + + + +Type: number +Format: float +Description: The length/duration of the fee free period + +FeeFreeLength [0..1] + + + +Type: string +Description: The unit of period (days, weeks, months etc.) of the promotional length +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +FeeFreeLengthPeriod [0..1] + + + + +Notes [0..*] + + + + +Segment [0..*] + + + + + +0..1 + + + +1..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBFundsConfirmation1.svg b/uml-diagrams/OBFundsConfirmation1.svg new file mode 100644 index 00000000..83da9739 --- /dev/null +++ b/uml-diagrams/OBFundsConfirmation1.svg @@ -0,0 +1,78 @@ + + + + + + + + + + + + + +OBFundsConfirmation1 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. + +ConsentId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. + +Reference [1..1] + + + + +Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + + +1..1 + + + +1..1 \ No newline at end of file diff --git a/uml-diagrams/OBFundsConfirmationConsent1.svg b/uml-diagrams/OBFundsConfirmationConsent1.svg new file mode 100644 index 00000000..e3e94c17 --- /dev/null +++ b/uml-diagrams/OBFundsConfirmationConsent1.svg @@ -0,0 +1,97 @@ + + + + + + + + + + + + + +OBFundsConfirmationConsent1 + + + + + +Data + + + +Type: string +Format: date-time +Description: Specified date and time the funds confirmation authorisation will expire. + If this is not populated, the authorisation will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + + +Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + + +1..1 + + + +1..1 \ No newline at end of file diff --git a/uml-diagrams/OBFundsConfirmationConsentResponse1.svg b/uml-diagrams/OBFundsConfirmationConsentResponse1.svg new file mode 100644 index 00000000..9c6c7953 --- /dev/null +++ b/uml-diagrams/OBFundsConfirmationConsentResponse1.svg @@ -0,0 +1,220 @@ + + + + + + + + + + + + + +OBFundsConfirmationConsentResponse1 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: Unique identification as assigned to identify the funds confirmation consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified date and time the funds confirmation authorisation will expire. +If this is not populated, the authorisation will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Rejected + - Revoked + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBFundsConfirmationResponse1.svg b/uml-diagrams/OBFundsConfirmationResponse1.svg new file mode 100644 index 00000000..70d9a21a --- /dev/null +++ b/uml-diagrams/OBFundsConfirmationResponse1.svg @@ -0,0 +1,186 @@ + + + + + + + + + + + + + +OBFundsConfirmationResponse1 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: boolean +Description: Flag to indicate the result of a confirmation of funds check. + +FundsAvailable [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource. + +FundsConfirmationId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. + +Reference [1..1] + + + + +Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBPCAData1.svg b/uml-diagrams/OBPCAData1.svg new file mode 100644 index 00000000..76dbe2b3 --- /dev/null +++ b/uml-diagrams/OBPCAData1.svg @@ -0,0 +1,2094 @@ + + + + + + + + + + + + + +OBPCAData1 + + + + +Details about the interest that may be payable to the PCA account holders +CreditInterest + + + + +The group of tiers or bands for which credit interest can be applied. +TierBandSet + + + +Type: string +Description: Methods of calculating interest +Values: + - Compound + - SimpleInterest + +CalculationMethod [0..1] + + + +Type: string +Description: Describes whether accrued interest is payable only to the PCA or to another bank account +Values: + - PayAway + - SelfCredit + +Destination [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: The methodology of how credit interest is charged. It can be:- + +1. Banded +Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. + +2. Tiered +Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. + +3. Whole +The same interest rate is applied irrespective of the PCA balance +Values: + - Tiered + - Whole + +TierBandMethod [1..1] + + + + +Tier Band Details +TierBand + + + +Type: string +Description: The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. + +Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +AER [1..1] + + + +Type: string +Description: How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA. +Values: + - PerAcademicTerm + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: Bank Interest for the PCA product +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +BankInterestRate [0..1] + + + +Type: string +Description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA. +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +BankInterestRateType [0..1] + + + +Type: string +Description: How often is credit interest calculated for the account. +Values: + - PerAcademicTerm + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount on which Interest applied. +Values: + - Tiered + - Whole + +DepositInterestAppliedCoverage [0..1] + + + +Type: string +Description: Type of interest rate, Fixed or Variable +Values: + - Fixed + - Variable + +FixedVariableInterestRateType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a PCA. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Maximum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMaximum [0..1] + + + +Type: string +Description: Minimum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMinimum [1..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other interest rate types which are not available in the standard code list +OtherBankInterestType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Contains details of fees and charges which are not associated with either borrowing or features/benefits +OtherFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +FeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - ServiceCAccountFee + - ServiceCAccountFeeMonthly + - ServiceCOther + - Other + +FeeType [1..1] + + + + +Notes [0..*] + + + + +Range or amounts or rates for which the fee/charge applies +FeeApplicableRange + + + +Type: string +Description: Maximum Amount on which fee is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MaximumAmount [0..1] + + + +Type: string +Description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MaximumRate [0..1] + + + +Type: string +Description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MinimumAmount [0..1] + + + +Type: string +Description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MinimumRate [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherFeeCategoryType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about Overdraft rates, fees & charges +Overdraft + + + + +Notes [0..*] + + + + +Tier band set details +OverdraftTierBandSet + + + +Type: boolean +Description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) + +AuthorisedIndicator [0..1] + + + +Type: string +Description: When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +BufferAmount [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft product. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. +Values: + - Committed + - OnDemand + - Other + +OverdraftType [0..1] + + + +Type: string +Description: The methodology of how overdraft is charged. It can be: +'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). +'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation +'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. +Values: + - Tiered + - Whole + - Banded + +TierBandMethod [1..1] + + + + +Overdraft fees and charges details +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - AnnualReview + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Provides overdraft details for a specific tier or band +OverdraftTierBand + + + +Type: boolean +Description: Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically + +BankGuaranteedIndicator [0..1] + + + +Type: string +Description: EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently +used interchangeably), being the actual annual interest rate of an Overdraft. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +EAR [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Interest charged on whole amount or tiered/banded +Values: + - Tiered + - Whole + +OverdraftInterestChargingCoverage [0..1] + + + +Type: string +Description: An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +RepresentativeAPR [0..1] + + + +Type: string +Description: Maximum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMax [0..1] + + + +Type: string +Description: Minimum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMin [1..1] + + + + +Overdraft fees and charges +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - AnnualReview + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +ProductDetails + + + +Type: string +Description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MonthlyMaximumCharge [0..1] + + + + +Notes [0..*] + + + + +Segment [0..*] + + + + + +0..1 + + + +1..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBParty2.svg b/uml-diagrams/OBParty2.svg new file mode 100644 index 00000000..eebae480 --- /dev/null +++ b/uml-diagrams/OBParty2.svg @@ -0,0 +1,265 @@ + + + + + + + + + + + + + +OBParty2 + + + +Type: string +Description: A party’s role with respect to the related account. +Values: + - UK.OBIE.Administrator + - UK.OBIE.Beneficiary + - UK.OBIE.CustodianForMinor + - UK.OBIE.Granter + - UK.OBIE.LegalGuardian + - UK.OBIE.OtherParty + - UK.OBIE.PowerOfAttorney + - UK.OBIE.Principal + - UK.OBIE.Protector + - UK.OBIE.RegisteredShareholderName + - UK.OBIE.SecondaryOwner + - UK.OBIE.SeniorManagingOfficial + - UK.OBIE.Settlor + - UK.OBIE.SuccessorOnDeath + +AccountRole [0..1] + + + +Type: boolean + +BeneficialOwnership [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Address for electronic mail (e-mail). + +EmailAddress [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Specifies a character string with a maximum length of 350 characters. + +FullLegalName [0..1] + + + +Type: string +Description: Legal standing of the party. +Values: + - UK.OBIE.CIC + - UK.OBIE.CIO + - UK.OBIE.Charity + - UK.OBIE.CoOp + - UK.OBIE.GeneralPartnership + - UK.OBIE.Individual + - UK.OBIE.LimitedLiabilityPartnership + - UK.OBIE.LimitedPartnership + - UK.OBIE.PrivateLimitedCompany + - UK.OBIE.PublicLimitedCompany + - UK.OBIE.ScottishLimitedPartnership + - UK.OBIE.Sole + +LegalStructure [0..1] + + + +Type: string +Description: Collection of information that identifies a mobile phone number, as defined by telecom services. +Pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} + +Mobile [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner. + +PartyId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number assigned by an agent to identify its customer. + +PartyNumber [0..1] + + + +Type: string +Description: Party type, in a coded form. +Values: + - Delegate + - Joint + - Sole + +PartyType [0..1] + + + +Type: string +Description: Collection of information that identifies a phone number, as defined by telecom services. +Pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} + +Phone [0..1] + + + + +Postal address of a party. +Address + + + + +AddressLine [0..5] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country eg, state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +The Party's relationships with other resources. +Relationships + + + + +Relationship to the Account resource. +Account + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Unique identification as assigned by the ASPSP to uniquely identify the related resource. + +Id [1..1] + + + +Type: string +Format: uri +Description: Absolute URI to the related resource. + +Related [1..1] + + + + + +0..* + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadAccount6.svg b/uml-diagrams/OBReadAccount6.svg new file mode 100644 index 00000000..50278726 --- /dev/null +++ b/uml-diagrams/OBReadAccount6.svg @@ -0,0 +1,328 @@ + + + + + + + + + + + + + +OBReadAccount6 + + + + + +Data + + + + +Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched: + + * Data.Currency + * Data.AccountType + * Data.AccountSubType + +For all other accounts, the fields must be populated by the ASPSP. +Account + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +Description: Specifies the sub type of account (product family group). +Values: + - ChargeCard + - CreditCard + - CurrentAccount + - EMoney + - Loan + - Mortgage + - PrePaidCard + - Savings + +AccountSubType [0..1] + + + +Type: string +Description: Specifies the type of account (personal or business). +Values: + - Business + - Personal + +AccountType [0..1] + + + +Type: string +Description: Identification of the currency in which the account is held. +Usage: Currency should only be used in case one and the same account number covers several currencies +and the initiating party needs to identify which currency needs to be used for settlement on the account. +Pattern: ^[A-Z]{3,3}$ + +Currency [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Specifies the description of the account type. + +Description [0..1] + + + +Type: string +Format: date-time +Description: Maturity date of the account.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +MaturityDate [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account. + +Nickname [0..1] + + + +Type: string +Format: date-time +Description: Date on which the account and related basic services are effectively operational for the account owner.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +OpeningDate [0..1] + + + +Type: string +Description: Specifies the status of account resource in code form. +Values: + - Deleted + - Disabled + - Enabled + - Pending + - ProForma + +Status [0..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [0..1] + + + +Type: string +Description: Specifies the switch status for the account, in a coded form. +Values: + - UK.CASS.NotSwitced + - UK.CASS.SwitchCompleted + +SwitchStatus [0..1] + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +Servicer + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadBalance1.svg b/uml-diagrams/OBReadBalance1.svg new file mode 100644 index 00000000..27703f96 --- /dev/null +++ b/uml-diagrams/OBReadBalance1.svg @@ -0,0 +1,260 @@ + + + + + + + + + + + + + +OBReadBalance1 + + + + + +Data + + + + +Set of elements used to define the balance details. +Balance + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +Description: Indicates whether the balance is a credit or a debit balance. +Usage: A zero balance is considered to be a credit balance. +Values: + - Credit + - Debit + +CreditDebitIndicator [1..1] + + + +Type: string +Format: date-time +Description: Indicates the date (and time) of the balance.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +DateTime [1..1] + + + +Type: string +Description: Balance type, in a coded form. +Values: + - ClosingAvailable + - ClosingBooked + - ClosingCleared + - Expected + - ForwardAvailable + - Information + - InterimAvailable + - InterimBooked + - InterimCleared + - OpeningAvailable + - OpeningBooked + - OpeningCleared + - PreviouslyClosedBooked + +Type [1..1] + + + + +Amount of money of the cash balance. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Set of elements used to provide details on the credit line. +CreditLine + + + +Type: boolean +Description: Indicates whether or not the credit line is included in the balance of the account. +Usage: If not present, credit line is not included in the balance amount of the account. + +Included [1..1] + + + +Type: string +Description: Limit type, in a coded form. +Values: + - Available + - Credit + - Emergency + - Pre-Agreed + - Temporary + +Type [0..1] + + + + +Amount of money of the credit line. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +1..* + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadBeneficiary5.svg b/uml-diagrams/OBReadBeneficiary5.svg new file mode 100644 index 00000000..1d2ad339 --- /dev/null +++ b/uml-diagrams/OBReadBeneficiary5.svg @@ -0,0 +1,367 @@ + + + + + + + + + + + + + +OBReadBeneficiary5 + + + + + +Data + + + + + +Beneficiary + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. + +BeneficiaryId [0..1] + + + +Type: string +Description: Specifies the Beneficiary Type. +Values: + - Trusted + - Ordinary + +BeneficiaryType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadConsent1.svg b/uml-diagrams/OBReadConsent1.svg new file mode 100644 index 00000000..6ec641ff --- /dev/null +++ b/uml-diagrams/OBReadConsent1.svg @@ -0,0 +1,82 @@ + + + + + + + + + + + + + +OBReadConsent1 + + + + + +Data + + + +Type: string +Format: date-time +Description: Specified date and time the permissions will expire. +If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + + +Permissions [1..*] + + + +Type: string +Format: date-time +Description: Specified start date and time for the transaction query period. +If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +TransactionFromDateTime [0..1] + + + +Type: string +Format: date-time +Description: Specified end date and time for the transaction query period. +If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +TransactionToDateTime [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. +Risk + + + + + +1..1 + + + +1..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadConsentResponse1.svg b/uml-diagrams/OBReadConsentResponse1.svg new file mode 100644 index 00000000..b0b1b663 --- /dev/null +++ b/uml-diagrams/OBReadConsentResponse1.svg @@ -0,0 +1,205 @@ + + + + + + + + + + + + + +OBReadConsentResponse1 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: Unique identification as assigned to identify the account access consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified date and time the permissions will expire. +If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + + +Permissions [1..*] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Rejected + - Revoked + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified start date and time for the transaction query period. +If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +TransactionFromDateTime [0..1] + + + +Type: string +Format: date-time +Description: Specified end date and time for the transaction query period. +If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +TransactionToDateTime [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. +Risk + + + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadDirectDebit2.svg b/uml-diagrams/OBReadDirectDebit2.svg new file mode 100644 index 00000000..4005e080 --- /dev/null +++ b/uml-diagrams/OBReadDirectDebit2.svg @@ -0,0 +1,224 @@ + + + + + + + + + + + + + +OBReadDirectDebit2 + + + + + +Data + + + + +Account to or from which a cash entry is made. +DirectDebit + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner. + +DirectDebitId [0..1] + + + +Type: string +Description: Specifies the status of the direct debit in code form. +Values: + - Active + - Inactive + +DirectDebitStatusCode [0..1] + + + +Type: string +Description: Regularity with which direct debit instructions are to be created and processed. +Values: + - UK.OBIE.Annual + - UK.OBIE.Daily + - UK.OBIE.Fortnightly + - UK.OBIE.HalfYearly + - UK.OBIE.Monthly + - UK.OBIE.NotKnown + - UK.OBIE.Quarterly + - UK.OBIE.Weekly + +Frequency [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference. + +MandateIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of Service User. + +Name [1..1] + + + +Type: string +Format: date-time +Description: Date of most recent direct debit collection.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +PreviousPaymentDateTime [0..1] + + + + +The amount of the most recent direct debit collection. +PreviousPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadOffer1.svg b/uml-diagrams/OBReadOffer1.svg new file mode 100644 index 00000000..5c2d7707 --- /dev/null +++ b/uml-diagrams/OBReadOffer1.svg @@ -0,0 +1,271 @@ + + + + + + + + + + + + + +OBReadOffer1 + + + + + +Data + + + + + +Offer + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 500 +Description: Further details of the offer. + +Description [0..1] + + + +Type: string +Format: date-time +Description: Date and time at which the offer ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +EndDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner. + +OfferId [0..1] + + + +Type: string +Description: Offer type, in a coded form. +Values: + - BalanceTransfer + - LimitIncrease + - MoneyTransfer + - Other + - PromotionalRate + +OfferType [0..1] + + + +Type: string +Description: Rate associated with the offer type. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +Rate [0..1] + + + +Type: string +Format: date-time +Description: Date and time at which the offer starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StartDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 500 +Description: Further details of the term of the offer. + +Term [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: URL (Uniform Resource Locator) where documentation on the offer can be found + +URL [0..1] + + + +Type: integer +Description: Value associated with the offer type. + +Value [0..1] + + + + +Amount of money associated with the offer type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Fee associated with the offer type. +Fee + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadParty2.svg b/uml-diagrams/OBReadParty2.svg new file mode 100644 index 00000000..bb5b6594 --- /dev/null +++ b/uml-diagrams/OBReadParty2.svg @@ -0,0 +1,367 @@ + + + + + + + + + + + + + +OBReadParty2 + + + + + +Data + + + + + +Party + + + +Type: string +Description: A party’s role with respect to the related account. +Values: + - UK.OBIE.Administrator + - UK.OBIE.Beneficiary + - UK.OBIE.CustodianForMinor + - UK.OBIE.Granter + - UK.OBIE.LegalGuardian + - UK.OBIE.OtherParty + - UK.OBIE.PowerOfAttorney + - UK.OBIE.Principal + - UK.OBIE.Protector + - UK.OBIE.RegisteredShareholderName + - UK.OBIE.SecondaryOwner + - UK.OBIE.SeniorManagingOfficial + - UK.OBIE.Settlor + - UK.OBIE.SuccessorOnDeath + +AccountRole [0..1] + + + +Type: boolean + +BeneficialOwnership [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Address for electronic mail (e-mail). + +EmailAddress [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Specifies a character string with a maximum length of 350 characters. + +FullLegalName [0..1] + + + +Type: string +Description: Legal standing of the party. +Values: + - UK.OBIE.CIC + - UK.OBIE.CIO + - UK.OBIE.Charity + - UK.OBIE.CoOp + - UK.OBIE.GeneralPartnership + - UK.OBIE.Individual + - UK.OBIE.LimitedLiabilityPartnership + - UK.OBIE.LimitedPartnership + - UK.OBIE.PrivateLimitedCompany + - UK.OBIE.PublicLimitedCompany + - UK.OBIE.ScottishLimitedPartnership + - UK.OBIE.Sole + +LegalStructure [0..1] + + + +Type: string +Description: Collection of information that identifies a mobile phone number, as defined by telecom services. +Pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} + +Mobile [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner. + +PartyId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number assigned by an agent to identify its customer. + +PartyNumber [0..1] + + + +Type: string +Description: Party type, in a coded form. +Values: + - Delegate + - Joint + - Sole + +PartyType [0..1] + + + +Type: string +Description: Collection of information that identifies a phone number, as defined by telecom services. +Pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} + +Phone [0..1] + + + + +Postal address of a party. +Address + + + + +AddressLine [0..5] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country eg, state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +The Party's relationships with other resources. +Relationships + + + + +Relationship to the Account resource. +Account + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Unique identification as assigned by the ASPSP to uniquely identify the related resource. + +Id [1..1] + + + +Type: string +Format: uri +Description: Absolute URI to the related resource. + +Related [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadParty3.svg b/uml-diagrams/OBReadParty3.svg new file mode 100644 index 00000000..9f07448a --- /dev/null +++ b/uml-diagrams/OBReadParty3.svg @@ -0,0 +1,367 @@ + + + + + + + + + + + + + +OBReadParty3 + + + + + +Data + + + + + +Party + + + +Type: string +Description: A party’s role with respect to the related account. +Values: + - UK.OBIE.Administrator + - UK.OBIE.Beneficiary + - UK.OBIE.CustodianForMinor + - UK.OBIE.Granter + - UK.OBIE.LegalGuardian + - UK.OBIE.OtherParty + - UK.OBIE.PowerOfAttorney + - UK.OBIE.Principal + - UK.OBIE.Protector + - UK.OBIE.RegisteredShareholderName + - UK.OBIE.SecondaryOwner + - UK.OBIE.SeniorManagingOfficial + - UK.OBIE.Settlor + - UK.OBIE.SuccessorOnDeath + +AccountRole [0..1] + + + +Type: boolean + +BeneficialOwnership [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Address for electronic mail (e-mail). + +EmailAddress [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Specifies a character string with a maximum length of 350 characters. + +FullLegalName [0..1] + + + +Type: string +Description: Legal standing of the party. +Values: + - UK.OBIE.CIC + - UK.OBIE.CIO + - UK.OBIE.Charity + - UK.OBIE.CoOp + - UK.OBIE.GeneralPartnership + - UK.OBIE.Individual + - UK.OBIE.LimitedLiabilityPartnership + - UK.OBIE.LimitedPartnership + - UK.OBIE.PrivateLimitedCompany + - UK.OBIE.PublicLimitedCompany + - UK.OBIE.ScottishLimitedPartnership + - UK.OBIE.Sole + +LegalStructure [0..1] + + + +Type: string +Description: Collection of information that identifies a mobile phone number, as defined by telecom services. +Pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} + +Mobile [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner. + +PartyId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number assigned by an agent to identify its customer. + +PartyNumber [0..1] + + + +Type: string +Description: Party type, in a coded form. +Values: + - Delegate + - Joint + - Sole + +PartyType [0..1] + + + +Type: string +Description: Collection of information that identifies a phone number, as defined by telecom services. +Pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} + +Phone [0..1] + + + + +Postal address of a party. +Address + + + + +AddressLine [0..5] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country eg, state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +The Party's relationships with other resources. +Relationships + + + + +Relationship to the Account resource. +Account + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Unique identification as assigned by the ASPSP to uniquely identify the related resource. + +Id [1..1] + + + +Type: string +Format: uri +Description: Absolute URI to the related resource. + +Related [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadProduct2.svg b/uml-diagrams/OBReadProduct2.svg new file mode 100644 index 00000000..c8e7e5d2 --- /dev/null +++ b/uml-diagrams/OBReadProduct2.svg @@ -0,0 +1,8378 @@ + + + + + + + + + + + + + +OBReadProduct2 + + + + +Aligning with the read write specs structure. +Data + + + + +Product details associated with the Account +Product + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Product Marketing State. + +MarketingStateId [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: The unique ID that has been internally assigned by the financial institution to each of the current account banking products they market to their retail and/or small to medium enterprise (SME) customers. + +ProductId [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise. + +ProductName [0..1] + + + +Type: string +Description: Product type : Personal Current Account, Business Current Account +Values: + - BusinessCurrentAccount + - CommercialCreditCard + - Other + - PersonalCurrentAccount + - SMELoan + +ProductType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products. + +SecondaryProductId [0..1] + + + + + +BCA + + + + +Details about the interest that may be payable to the BCA account holders +CreditInterest + + + + +The group of tiers or bands for which credit interest can be applied. +TierBandSet + + + +Type: string +Description: Methods of calculating interest +Values: + - Compound + - SimpleInterest + +CalculationMethod [0..1] + + + +Type: string +Description: Describes whether accrued interest is payable only to the BCA or to another bank account +Values: + - PayAway + - SelfCredit + +Destination [1..1] + + + + +Notes [0..*] + + + +Type: string +Description: The methodology of how credit interest is paid/applied. It can be:- + +1. Banded +Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. + +2. Tiered +Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. + +3. Whole +The same interest rate is applied irrespective of the BCA balance +Values: + - Banded + - Tiered + - Whole + +TierBandMethod [1..1] + + + + +Tier Band Details +TierBand + + + +Type: string +Description: The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. + +Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +AER [1..1] + + + +Type: string +Description: How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA. +Values: + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: Bank Interest for the BCA product +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +BankInterestRate [0..1] + + + +Type: string +Description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA. +Values: + - Gross + - Other + +BankInterestRateType [0..1] + + + +Type: string +Description: How often is credit interest calculated for the account. +Values: + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount on which Interest applied. +Values: + - Banded + - Tiered + - Whole + +DepositInterestAppliedCoverage [0..1] + + + +Type: string +Description: Type of interest rate, Fixed or Variable +Values: + - Fixed + - Variable + +FixedVariableInterestRateType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a BCA. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Maximum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMaximum [0..1] + + + +Type: string +Description: Minimum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMinimum [1..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other interest rate types which are not available in the standard code list +OtherBankInterestType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Contains details of fees and charges which are not associated with either Overdraft or features/benefits +OtherFeesCharges + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the tariff + +TariffName [0..1] + + + +Type: string +Description: TariffType which defines the fee and charges. +Values: + - Electronic + - Mixed + - Other + +TariffType [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular or group of fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +FeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - Gross + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - Other + - ServiceCAccountFee + - ServiceCAccountFeeMonthly + - ServiceCAccountFeeQuarterly + - ServiceCFixedTariff + - ServiceCBusiDepAccBreakage + - ServiceCMinimumMonthlyFee + - ServiceCOther + +FeeType [1..1] + + + +Type: boolean +Description: Fee/charge which is usually negotiable rather than a fixed amount + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + + +Range or amounts or rates for which the fee/charge applies +FeeApplicableRange + + + +Type: string +Description: Maximum Amount on which fee is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MaximumAmount [0..1] + + + +Type: string +Description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MaximumRate [0..1] + + + +Type: string +Description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MinimumAmount [0..1] + + + +Type: string +Description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MinimumRate [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular or group of fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherFeeCategoryType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other tariff type which is not in the standard list. +OtherTariffType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Borrowing details +Overdraft + + + + +Notes [0..*] + + + + +Tier band set details +OverdraftTierBandSet + + + +Type: boolean +Description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) + +AuthorisedIndicator [0..1] + + + +Type: string +Description: When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +BufferAmount [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft product. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. +Values: + - Committed + - OnDemand + +OverdraftType [0..1] + + + +Type: string +Description: The methodology of how overdraft is charged. It can be: +'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). +'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation +'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. +Values: + - Banded + - Tiered + - Whole + +TierBandMethod [1..1] + + + + +Overdraft fees and charges details +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - Gross + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - AnnualReview + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + +Type: boolean +Description: Indicates whether fee and charges are negotiable + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Provides overdraft details for a specific tier or band +OverdraftTierBand + + + +Type: number +Format: float +Description: Specifies the maximum length of a band for a fixed overdraft agreement + +AgreementLengthMax [0..1] + + + +Type: number +Format: float +Description: Specifies the minimum length of a band for a fixed overdraft agreement + +AgreementLengthMin [0..1] + + + +Type: string +Description: Specifies the period of a fixed length overdraft agreement +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +AgreementPeriod [0..1] + + + +Type: boolean +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +BankGuaranteedIndicator [0..1] + + + +Type: string +Description: EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently +used interchangeably), being the actual annual interest rate of an Overdraft. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +EAR [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’. +Values: + - Banded + - Tiered + - Whole + +OverdraftInterestChargingCoverage [0..1] + + + +Type: string +Description: An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +RepresentativeAPR [0..1] + + + +Type: string +Description: Maximum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMax [0..1] + + + +Type: string +Description: Minimum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMin [1..1] + + + + +Overdraft fees and charges +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - OnClosing + - OnOpening + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAnniversary + - Other + - PerHundredPounds + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - Gross + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - AnnualReview + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + +Type: boolean +Description: Indicates whether fee and charges are negotiable + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +ProductDetails + + + +Type: number +Format: float +Description: The length/duration of the fee free period + +FeeFreeLength [0..1] + + + +Type: string +Description: The unit of period (days, weeks, months etc.) of the promotional length +Values: + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +FeeFreeLengthPeriod [0..1] + + + + +Notes [0..*] + + + + +Segment [0..*] + + + + +Other product type details associated with the account. +OtherProductType + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description of the Product associated with the account + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Long name associated with the product + +Name [1..1] + + + + +Details about the interest that may be payable to the Account holders +CreditInterest + + + + +The group of tiers or bands for which credit interest can be applied. +TierBandSet + + + +Type: string +Description: Methods of calculating interest +Values: + - ITCO + - ITOT + - ITSI + +CalculationMethod [0..1] + + + +Type: string +Description: Describes whether accrued interest is payable only to the BCA or to another bank account +Values: + - INOT + - INPA + - INSC + +Destination [1..1] + + + + +Notes [0..*] + + + +Type: string +Description: The methodology of how credit interest is paid/applied. It can be:- +1. Banded +Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. +2. Tiered +Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. +3. Whole +The same interest rate is applied irrespective of the product holder's account balance +Values: + - INBA + - INTI + - INWH + +TierBandMethod [1..1] + + + + + +OtherCalculationMethod + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherDestination + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Tier Band Details +TierBand + + + +Type: string +Description: The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. +Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +AER [1..1] + + + +Type: string +Description: How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account. +Values: + - FQAT + - FQDY + - FQHY + - FQMY + - FQOT + - FQQY + - FQSD + - FQWY + - FQYY + +ApplicationFrequency [1..1] + + + +Type: string +Description: Bank Interest for the product +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +BankInterestRate [0..1] + + + +Type: string +Description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account. +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +BankInterestRateType [0..1] + + + +Type: string +Description: How often is credit interest calculated for the account. +Values: + - FQAT + - FQDY + - FQHY + - FQMY + - FQOT + - FQQY + - FQSD + - FQWY + - FQYY + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount on which Interest applied. +Values: + - INBA + - INTI + - INWH + +DepositInterestAppliedCoverage [0..1] + + + +Type: string +Description: Type of interest rate, Fixed or Variable +Values: + - INFI + - INVA + +FixedVariableInterestRateType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for the Product. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Maximum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMaximum [0..1] + + + +Type: string +Description: Minimum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMinimum [1..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other interest rate types which are not available in the standard code list +OtherBankInterestType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the interest that may be payable to the SME Loan holders +LoanInterest + + + + +Notes [0..*] + + + + +The group of tiers or bands for which debit interest can be applied. +LoanInterestTierBandSet + + + +Type: string +Description: Methods of calculating interest +Values: + - ITCO + - ITOT + - ITSI + +CalculationMethod [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Loan interest tierbandset identification. Used by loan providers for internal use purpose. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: The methodology of how credit interest is charged. It can be:- +1. Banded +Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. +2. Tiered +Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. +3. Whole +The same interest rate is applied irrespective of the SME Loan balance +Values: + - INBA + - INTI + - INWH + +TierBandMethod [1..1] + + + + +Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits +LoanInterestFeesCharges + + + + +Details about any caps (minimum/maximum charges) that apply to a particular fee/charge +LoanInterestFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +LoanInterestFeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CalculationFrequency [1..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - FEPF + - FTOT + - FYAF + - FYAM + - FYAQ + - FYCP + - FYDB + - FYMI + - FYXX + +FeeType [1..1] + + + +Type: boolean +Description: Fee/charge which is usually negotiable rather than a fixed amount + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not in the standard rate type list +OtherFeeRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - FCOT + - FCRE + - FCSV + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Tier Band Details +LoanInterestTierBand + + + +Type: string +Description: Type of interest rate, Fixed or Variable +Values: + - INFI + - INVA + +FixedVariableInterestRateType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a SME Loan. + +Identification [0..1] + + + +Type: string +Description: Loan provider Interest for the SME Loan product +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +LoanProviderInterestRate [0..1] + + + +Type: string +Description: Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan. +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +LoanProviderInterestRateType [0..1] + + + +Type: string +Description: The unit of period (days, weeks, months etc.) of the Maximum Term +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +MaxTermPeriod [0..1] + + + +Type: string +Description: The unit of period (days, weeks, months etc.) of the Minimum Term +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +MinTermPeriod [1..1] + + + + +Notes [0..*] + + + +Type: string +Description: The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. +For SME Loan, this APR is the representative APR which includes any account fees. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +RepAPR [1..1] + + + +Type: integer +Description: Maximum loan term for which the loan interest tier applies. + +TierValueMaxTerm [0..1] + + + +Type: string +Description: Maximum loan value for which the loan interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMaximum [0..1] + + + +Type: integer +Description: Minimum loan term for which the loan interest tier applies. + +TierValueMinTerm [1..1] + + + +Type: string +Description: Minimum loan value for which the loan interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMinimum [1..1] + + + + +Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits +LoanInterestFeesCharges + + + + +Details about any caps (minimum/maximum charges) that apply to a particular fee/charge +LoanInterestFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +LoanInterestFeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CalculationFrequency [1..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - FEPF + - FTOT + - FYAF + - FYAM + - FYAQ + - FYCP + - FYDB + - FYMI + - FYXX + +FeeType [1..1] + + + +Type: boolean +Description: Fee/charge which is usually negotiable rather than a fixed amount + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not in the standard rate type list +OtherFeeRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - FCOT + - FCRE + - FCSV + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other loan interest rate types which are not available in the standard code list +OtherLoanProviderInterestRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherCalculationMethod + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Contains details of fees and charges which are not associated with either Overdraft or features/benefits +OtherFeesCharges + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the tariff + +TariffName [0..1] + + + +Type: string +Description: TariffType which defines the fee and charges. +Values: + - TTEL + - TTMX + - TTOT + +TariffType [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular or group of fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +FeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CalculationFrequency [0..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - FCOT + - FCRE + - FCSV + +FeeCategory [1..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - FEPF + - FTOT + - FYAF + - FYAM + - FYAQ + - FYCP + - FYDB + - FYMI + - FYXX + +FeeType [1..1] + + + +Type: boolean +Description: Fee/charge which is usually negotiable rather than a fixed amount + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + + +Range or amounts or rates for which the fee/charge applies +FeeApplicableRange + + + +Type: string +Description: Maximum Amount on which fee is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MaximumAmount [0..1] + + + +Type: string +Description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MaximumRate [0..1] + + + +Type: string +Description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MinimumAmount [0..1] + + + +Type: string +Description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MinimumRate [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular or group of fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherFeeCategoryType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not available in the standard code set +OtherFeeRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - FCOT + - FCRE + - FCSV + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other tariff type which is not in the standard list. +OtherTariffType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Borrowing details +Overdraft + + + + +Notes [0..*] + + + + +Tier band set details +OverdraftTierBandSet + + + +Type: boolean +Description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) + +AuthorisedIndicator [0..1] + + + +Type: string +Description: When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +BufferAmount [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft product. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. +Values: + - OVCO + - OVOD + - OVOT + +OverdraftType [0..1] + + + +Type: string +Description: The methodology of how overdraft is charged. It can be: +'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). +'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation +'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. +Values: + - INBA + - INTI + - INWH + +TierBandMethod [1..1] + + + + +Overdraft fees and charges details +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - FBAO + - FBAR + - FBEB + - FBIT + - FBOR + - FBOS + - FBSC + - FBTO + - FBUB + - FBUT + - FTOT + - FTUT + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + +Type: boolean +Description: Indicates whether fee and charges are negotiable + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Provides overdraft details for a specific tier or band +OverdraftTierBand + + + +Type: integer +Description: Specifies the maximum length of a band for a fixed overdraft agreement + +AgreementLengthMax [0..1] + + + +Type: integer +Description: Specifies the minimum length of a band for a fixed overdraft agreement + +AgreementLengthMin [0..1] + + + +Type: string +Description: Specifies the period of a fixed length overdraft agreement +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +AgreementPeriod [0..1] + + + +Type: boolean +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances. + +BankGuaranteedIndicator [0..1] + + + +Type: string +Description: EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently +used interchangeably), being the actual annual interest rate of an Overdraft. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +EAR [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is �2k and the interest tiers are:- 0-�500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the �Whole� of the account balance, and in the 2nd that it is �Tiered�. +Values: + - INBA + - INTI + - INWH + +OverdraftInterestChargingCoverage [0..1] + + + +Type: string +Description: Maximum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMax [0..1] + + + +Type: string +Description: Minimum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMin [1..1] + + + + +Overdraft fees and charges +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - FBAO + - FBAR + - FBEB + - FBIT + - FBOR + - FBOS + - FBSC + - FBTO + - FBUB + - FBUT + - FTOT + - FTUT + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + +Type: boolean +Description: Indicates whether fee and charges are negotiable + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances. + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +ProductDetails + + + +Type: integer +Description: The length/duration of the fee free period + +FeeFreeLength [0..1] + + + +Type: string +Description: The unit of period (days, weeks, months etc.) of the promotional length +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +FeeFreeLengthPeriod [0..1] + + + +Type: string +Description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MonthlyMaximumCharge [0..1] + + + + +Notes [0..*] + + + + +Segment [0..*] + + + + + +OtherSegment + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Repayment details of the Loan product +Repayment + + + +Type: string +Description: The repayment is for paying just the interest only or both interest and capital or bullet amount or balance to date etc +Values: + - RABD + - RABL + - RACI + - RAFC + - RAIO + - RALT + - USOT + +AmountType [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Repayment frequency +Values: + - SMDA + - SMFL + - SMFO + - SMHY + - SMMO + - SMOT + - SMQU + - SMWE + - SMYE + +RepaymentFrequency [0..1] + + + +Type: string +Description: Repayment type +Values: + - USBA + - USBU + - USCI + - USCS + - USER + - USFA + - USFB + - USFI + - USIO + - USOT + - USPF + - USRW + - USSL + +RepaymentType [0..1] + + + + +Other amount type which is not in the standard code list +OtherAmountType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other repayment frequency which is not in the standard code list +OtherRepaymentFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other repayment type which is not in the standard code list +OtherRepaymentType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment. +RepaymentFeeCharges + + + + +RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged +RepaymentFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: integer +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Min Max type +Values: + - FMMN + - FMMX + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about specific fees/charges that are applied for repayment +RepaymentFeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - FEAC + - FEAO + - FECP + - FEDA + - FEHO + - FEI + - FEMO + - FEOA + - FEOT + - FEPC + - FEPH + - FEPO + - FEPS + - FEPT + - FEPTA + - FEPTP + - FEQU + - FESM + - FEST + - FEWE + - FEYE + +CalculationFrequency [1..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - INBB + - INFR + - INGR + - INLR + - INNE + - INOT + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - FEPF + - FTOT + - FYAF + - FYAM + - FYAQ + - FYCP + - FYDB + - FYMI + - FYXX + +FeeType [1..1] + + + +Type: boolean +Description: Fee/charge which is usually negotiable rather than a fixed amount + +NegotiableIndicator [0..1] + + + + +Notes [0..*] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not available in the standard code set +OtherFeeRateType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - FCOT + - FCRE + - FCSV + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details of capital repayment holiday if any +RepaymentHoliday + + + +Type: integer +Description: The maximum length/duration of a Repayment Holiday + +MaxHolidayLength [0..1] + + + +Type: string +Description: The unit of period (days, weeks, months etc.) of the repayment holiday +Values: + - PACT + - PDAY + - PHYR + - PMTH + - PQTR + - PWEK + - PYER + +MaxHolidayPeriod [0..1] + + + + +Notes [0..*] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + + +PCA + + + + +Details about the interest that may be payable to the PCA account holders +CreditInterest + + + + +The group of tiers or bands for which credit interest can be applied. +TierBandSet + + + +Type: string +Description: Methods of calculating interest +Values: + - Compound + - SimpleInterest + +CalculationMethod [0..1] + + + +Type: string +Description: Describes whether accrued interest is payable only to the PCA or to another bank account +Values: + - PayAway + - SelfCredit + +Destination [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: The methodology of how credit interest is charged. It can be:- + +1. Banded +Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. + +2. Tiered +Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. + +3. Whole +The same interest rate is applied irrespective of the PCA balance +Values: + - Tiered + - Whole + +TierBandMethod [1..1] + + + + +Tier Band Details +TierBand + + + +Type: string +Description: The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. + +Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +AER [1..1] + + + +Type: string +Description: How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA. +Values: + - PerAcademicTerm + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: Bank Interest for the PCA product +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +BankInterestRate [0..1] + + + +Type: string +Description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA. +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +BankInterestRateType [0..1] + + + +Type: string +Description: How often is credit interest calculated for the account. +Values: + - PerAcademicTerm + - Daily + - HalfYearly + - Monthly + - Other + - Quarterly + - PerStatementDate + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount on which Interest applied. +Values: + - Tiered + - Whole + +DepositInterestAppliedCoverage [0..1] + + + +Type: string +Description: Type of interest rate, Fixed or Variable +Values: + - Fixed + - Variable + +FixedVariableInterestRateType [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a PCA. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Maximum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMaximum [0..1] + + + +Type: string +Description: Minimum deposit value for which the credit interest tier applies. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMinimum [1..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other interest rate types which are not available in the standard code list +OtherBankInterestType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Contains details of fees and charges which are not associated with either borrowing or features/benefits +OtherFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fees/charges details +FeeChargeDetail + + + +Type: string +Description: How frequently the fee/charge is applied to the account +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How frequently the fee/charge is calculated +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +Description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Fee/Charge Type +Values: + - ServiceCAccountFee + - ServiceCAccountFeeMonthly + - ServiceCOther + - Other + +FeeType [1..1] + + + + +Notes [0..*] + + + + +Range or amounts or rates for which the fee/charge applies +FeeApplicableRange + + + +Type: string +Description: Maximum Amount on which fee is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MaximumAmount [0..1] + + + +Type: string +Description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MaximumRate [0..1] + + + +Type: string +Description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MinimumAmount [0..1] + + + +Type: string +Description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +MinimumRate [0..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +FeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other application frequencies not covered in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +OtherFeeCategoryType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee/charge type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +Description: Categorisation of fees and charges into standard categories. +Values: + - Other + - Servicing + +FeeCategory [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about Overdraft rates, fees & charges +Overdraft + + + + +Notes [0..*] + + + + +Tier band set details +OverdraftTierBandSet + + + +Type: boolean +Description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) + +AuthorisedIndicator [0..1] + + + +Type: string +Description: When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply. +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +BufferAmount [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft product. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. +Values: + - Committed + - OnDemand + - Other + +OverdraftType [0..1] + + + +Type: string +Description: The methodology of how overdraft is charged. It can be: +'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). +'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation +'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. +Values: + - Tiered + - Whole + - Banded + +TierBandMethod [1..1] + + + + +Overdraft fees and charges details +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - AnnualReview + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Provides overdraft details for a specific tier or band +OverdraftTierBand + + + +Type: boolean +Description: Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically + +BankGuaranteedIndicator [0..1] + + + +Type: string +Description: EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently +used interchangeably), being the actual annual interest rate of an Overdraft. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +EAR [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a Tier Band for a overdraft. + +Identification [0..1] + + + + +Notes [0..*] + + + +Type: string +Description: Interest charged on whole amount or tiered/banded +Values: + - Tiered + - Whole + +OverdraftInterestChargingCoverage [0..1] + + + +Type: string +Description: An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +RepresentativeAPR [0..1] + + + +Type: string +Description: Maximum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMax [0..1] + + + +Type: string +Description: Minimum value of Overdraft Tier/Band +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +TierValueMin [1..1] + + + + +Overdraft fees and charges +OverdraftFeesCharges + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about the fees/charges +OverdraftFeeChargeDetail + + + +Type: string +Description: Frequency at which the overdraft charge is applied to the account +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +ApplicationFrequency [1..1] + + + +Type: string +Description: How often is the overdraft fee/charge calculated for the account. +Values: + - AccountClosing + - AccountOpening + - AcademicTerm + - ChargingPeriod + - Daily + - PerItem + - Monthly + - OnAccountAnniversary + - Other + - PerHour + - PerOccurrence + - PerSheet + - PerTransaction + - PerTransactionAmount + - PerTransactionPercentage + - Quarterly + - SixMonthly + - StatementMonthly + - Weekly + - Yearly + +CalculationFrequency [0..1] + + + +Type: string +Description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeAmount [0..1] + + + +Type: string +Description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ + +FeeRate [0..1] + + + +Type: string +Description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) +Values: + - LinkedBaseRate + - Gross + - Net + - Other + +FeeRateType [0..1] + + + +Type: string +Description: Overdraft fee type +Values: + - ArrangedOverdraft + - EmergencyBorrowing + - BorrowingItem + - OverdraftRenewal + - AnnualReview + - OverdraftSetup + - Surcharge + - TempOverdraft + - UnauthorisedBorrowing + - UnauthorisedPaidTrans + - Other + - UnauthorisedUnpaidTrans + +FeeType [1..1] + + + +Type: string +Description: Every additional tranche of an overdraft balance to which an overdraft fee is applied +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +IncrementalBorrowingAmount [0..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other application frequencies that are not available in the standard code list +OtherApplicationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other calculation frequency which is not available in the standard code set. +OtherCalculationFrequency + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other fee rate type code which is not available in the standard code set +OtherFeeRateType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Other Fee type which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + +Details about any caps (maximum charges) that apply to a particular fee/charge +OverdraftFeeChargeCap + + + +Type: string +Description: Period e.g. day, week, month etc. for which the fee/charge is capped +Values: + - AcademicTerm + - Day + - Half Year + - Month + - Quarter + - Week + - Year + +CappingPeriod [0..1] + + + +Type: string +Description: Cap amount charged for a fee/charge +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +FeeCapAmount [0..1] + + + +Type: number +Format: float +Description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount + +FeeCapOccurrence [0..1] + + + + +FeeType [1..*] + + + +Type: string +Description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution +Values: + - Minimum + - Maximum + +MinMaxType [1..1] + + + + +Notes [0..*] + + + +Type: boolean +Description: Specifies for the overdraft control feature/benefit + +OverdraftControlIndicator [0..1] + + + + +Other fee type code which is not available in the standard code set +OtherFeeType + + + +Type: string +MinLength: 0 +MaxLength: 4 +Description: The four letter Mnemonic used within an XML file to identify a code +Pattern: ^\w{0,4}$ + +Code [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Description to describe the purpose of the code + +Description [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Long name associated with the code + +Name [1..1] + + + + + +ProductDetails + + + +Type: string +Description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order +Pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ + +MonthlyMaximumCharge [0..1] + + + + +Notes [0..*] + + + + +Segment [0..*] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +1..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..1 + + + +0..1 + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..* + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +1..* + + + +0..* + + + +0..* + + + +0..* + + + +1..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadScheduledPayment3.svg b/uml-diagrams/OBReadScheduledPayment3.svg new file mode 100644 index 00000000..62a81d14 --- /dev/null +++ b/uml-diagrams/OBReadScheduledPayment3.svg @@ -0,0 +1,292 @@ + + + + + + + + + + + + + +OBReadScheduledPayment3 + + + + + +Data + + + + + +ScheduledPayment + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: A reference value provided by the PSU to the PISP while setting up the scheduled payment. + +DebtorReference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + +Type: string +Format: date-time +Description: The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ScheduledPaymentDateTime [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner. + +ScheduledPaymentId [0..1] + + + +Type: string +Description: Specifies the scheduled payment date type requested +Values: + - Arrival + - Execution + +ScheduledType [1..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Beneficiary account identification. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadStandingOrder6.svg b/uml-diagrams/OBReadStandingOrder6.svg new file mode 100644 index 00000000..84cb5eb7 --- /dev/null +++ b/uml-diagrams/OBReadStandingOrder6.svg @@ -0,0 +1,448 @@ + + + + + + + + + + + + + +OBReadStandingOrder6 + + + + + +Data + + + + + +StandingOrder + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [0..1] + + + +Type: string +Description: Individual Definitions: +NotKnown - Not Known +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlDay - An interval specified in number of calendar days (02 to 31) +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +NotKnown (ScheduleCode) +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +NotKnown +EvryDay +EvryWorkgDay +IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +Format: date-time +Description: The date on which the last (most recent) payment for a Standing Order schedule was made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +NextPaymentDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner. + +StandingOrderId [0..1] + + + +Type: string +Description: Specifies the status of the standing order in code form. +Values: + - Active + - Inactive + +StandingOrderStatusCode [0..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Beneficiary account identification. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [1..1] + + + + +The amount of the final Standing Order +FinalPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the first Standing Order +FirstPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the last (most recent) Standing Order instruction. +LastPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the next Standing Order. +NextPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBReadTransaction6.svg b/uml-diagrams/OBReadTransaction6.svg new file mode 100644 index 00000000..5b27968b --- /dev/null +++ b/uml-diagrams/OBReadTransaction6.svg @@ -0,0 +1,962 @@ + + + + + + + + + + + + + +OBReadTransaction6 + + + + + +Data + + + + +Provides further details on an entry in the report. +Transaction + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. + +AccountId [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text. + +AddressLine [0..1] + + + +Type: string +Format: date-time +Description: Date and time when a transaction entry is posted to an account on the account servicer's books. +Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +BookingDateTime [1..1] + + + +Type: string +Description: Indicates whether the transaction is a credit or a debit entry. +Values: + - Credit + - Debit + +CreditDebitIndicator [1..1] + + + + +StatementReference [0..*] + + + +Type: string +Description: Status of a transaction entry on the books of the account servicer. +Values: + - Booked + - Pending + +Status [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 210 +Description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. + +TransactionId [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 500 +Description: Further details of the transaction. +This is the transaction narrative, which is unstructured text. + +TransactionInformation [0..1] + + + +Type: string +Description: Specifies the Mutability of the Transaction record. +Values: + - Mutable + - Immutable + +TransactionMutability [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 210 +Description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. + +TransactionReference [0..1] + + + +Type: string +Format: date-time +Description: Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. +Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. +For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ValueDateTime [0..1] + + + + +Amount of money in the cash transaction entry. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account. +Balance + + + +Type: string +Description: Indicates whether the balance is a credit or a debit balance. +Usage: A zero balance is considered to be a credit balance. +Values: + - Credit + - Debit + +CreditDebitIndicator [1..1] + + + +Type: string +Description: Balance type, in a coded form. +Values: + - ClosingAvailable + - ClosingBooked + - ClosingCleared + - Expected + - ForwardAvailable + - Information + - InterimAvailable + - InterimBooked + - InterimCleared + - OpeningAvailable + - OpeningBooked + - OpeningCleared + - PreviouslyClosedBooked + +Type [1..1] + + + + +Amount of money of the cash balance after a transaction entry is applied to the account.. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Set of elements used to fully identify the type of underlying transaction resulting in an entry. +BankTransactionCode + + + +Type: string +Description: Specifies the family within a domain. + +Code [1..1] + + + +Type: string +Description: Specifies the sub-product family within a specific family. + +SubCode [1..1] + + + + +Set of elements to describe the card instrument used in the transaction. +CardInstrument + + + +Type: string +Description: The card authorisation type. +Values: + - ConsumerDevice + - Contactless + - None + - PIN + +AuthorisationType [0..1] + + + +Type: string +Description: Name of the card scheme. +Values: + - AmericanExpress + - Diners + - Discover + - MasterCard + - VISA + +CardSchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of the cardholder using the card instrument. + +Name [0..1] + + + + +Transaction charges to be paid by the charge bearer. +ChargeAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Unambiguous identification of the account of the creditor, in the case of a debit transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Set of elements used to provide details on the currency exchange. +CurrencyExchange + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification to unambiguously identify the foreign exchange contract. + +ContractIdentification [0..1] + + + +Type: number +Description: Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. +Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). + +ExchangeRate [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which an exchange rate is quoted.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +QuotationDate [0..1] + + + +Type: string +Description: Currency from which an amount is to be converted in a currency conversion. +Pattern: ^[A-Z]{3,3}$ + +SourceCurrency [1..1] + + + +Type: string +Description: Currency into which an amount is to be converted in a currency conversion. +Pattern: ^[A-Z]{3,3}$ + +TargetCurrency [0..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Unambiguous identification of the account of the debtor, in the case of a crebit transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the debtor. +DebtorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Details of the merchant involved in the transaction. +MerchantDetails + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which the merchant is known. + +MerchantName [0..1] + + + + +Set of elements to fully identify a proprietary bank transaction code. +ProprietaryBankTransactionCode + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Proprietary bank transaction code to identify the underlying transaction. + +Code [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identification of the issuer of the proprietary bank transaction code. + +Issuer [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBRisk1.svg b/uml-diagrams/OBRisk1.svg new file mode 100644 index 00000000..f102a24e --- /dev/null +++ b/uml-diagrams/OBRisk1.svg @@ -0,0 +1,123 @@ + + + + + + + + + + + + + +OBRisk1 + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBSCASupportData1.svg b/uml-diagrams/OBSCASupportData1.svg new file mode 100644 index 00000000..75fce9ed --- /dev/null +++ b/uml-diagrams/OBSCASupportData1.svg @@ -0,0 +1,60 @@ + + + + + + + + + + + + + +OBSCASupportData1 + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomestic2.svg b/uml-diagrams/OBWriteDomestic2.svg new file mode 100644 index 00000000..c4245da4 --- /dev/null +++ b/uml-diagrams/OBWriteDomestic2.svg @@ -0,0 +1,479 @@ + + + + + + + + + + + + + +OBWriteDomestic2 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticConsent4.svg b/uml-diagrams/OBWriteDomesticConsent4.svg new file mode 100644 index 00000000..956db6d0 --- /dev/null +++ b/uml-diagrams/OBWriteDomesticConsent4.svg @@ -0,0 +1,556 @@ + + + + + + + + + + + + + +OBWriteDomesticConsent4 + + + + + +Data + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticConsentResponse5.svg b/uml-diagrams/OBWriteDomesticConsentResponse5.svg new file mode 100644 index 00000000..a1d2c80d --- /dev/null +++ b/uml-diagrams/OBWriteDomesticConsentResponse5.svg @@ -0,0 +1,804 @@ + + + + + + + + + + + + + +OBWriteDomesticConsentResponse5 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticResponse5.svg b/uml-diagrams/OBWriteDomesticResponse5.svg new file mode 100644 index 00000000..d7b69e58 --- /dev/null +++ b/uml-diagrams/OBWriteDomesticResponse5.svg @@ -0,0 +1,728 @@ + + + + + + + + + + + + + +OBWriteDomesticResponse5 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource. + +DomesticPaymentId [1..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +Description: Specifies the status of the payment information group. +Values: + - AcceptedCreditSettlementCompleted + - AcceptedSettlementCompleted + - AcceptedSettlementInProcess + - AcceptedWithoutPosting + - Pending + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + +Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. +Refund + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticScheduled2.svg b/uml-diagrams/OBWriteDomesticScheduled2.svg new file mode 100644 index 00000000..faa6e56e --- /dev/null +++ b/uml-diagrams/OBWriteDomesticScheduled2.svg @@ -0,0 +1,490 @@ + + + + + + + + + + + + + +OBWriteDomesticScheduled2 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticScheduledConsent4.svg b/uml-diagrams/OBWriteDomesticScheduledConsent4.svg new file mode 100644 index 00000000..7ede54c0 --- /dev/null +++ b/uml-diagrams/OBWriteDomesticScheduledConsent4.svg @@ -0,0 +1,576 @@ + + + + + + + + + + + + + +OBWriteDomesticScheduledConsent4 + + + + + +Data + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticScheduledConsentResponse5.svg b/uml-diagrams/OBWriteDomesticScheduledConsentResponse5.svg new file mode 100644 index 00000000..de8e15fe --- /dev/null +++ b/uml-diagrams/OBWriteDomesticScheduledConsentResponse5.svg @@ -0,0 +1,824 @@ + + + + + + + + + + + + + +OBWriteDomesticScheduledConsentResponse5 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticScheduledResponse5.svg b/uml-diagrams/OBWriteDomesticScheduledResponse5.svg new file mode 100644 index 00000000..e12c4136 --- /dev/null +++ b/uml-diagrams/OBWriteDomesticScheduledResponse5.svg @@ -0,0 +1,737 @@ + + + + + + + + + + + + + +OBWriteDomesticScheduledResponse5 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource. + +DomesticScheduledPaymentId [1..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +Description: Specifies the status of the payment order resource. +Values: + - Cancelled + - InitiationCompleted + - InitiationFailed + - InitiationPending + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. +Initiation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +CreditorPostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + +Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. +Refund + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticStandingOrder3.svg b/uml-diagrams/OBWriteDomesticStandingOrder3.svg new file mode 100644 index 00000000..985e472b --- /dev/null +++ b/uml-diagrams/OBWriteDomesticStandingOrder3.svg @@ -0,0 +1,439 @@ + + + + + + + + + + + + + +OBWriteDomesticStandingOrder3 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. +Initiation + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first recurring payment for a Standing Order schedule will be made. +Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RecurringPaymentDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Identification assigned by an institution to identify an account. This identification is known by the account owner. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides the details to identify the debtor account. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +The amount of the final Standing Order +FinalPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the first Standing Order +FirstPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the recurring Standing Order +RecurringPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticStandingOrderConsent5.svg b/uml-diagrams/OBWriteDomesticStandingOrderConsent5.svg new file mode 100644 index 00000000..90bac5bf --- /dev/null +++ b/uml-diagrams/OBWriteDomesticStandingOrderConsent5.svg @@ -0,0 +1,525 @@ + + + + + + + + + + + + + +OBWriteDomesticStandingOrderConsent5 + + + + + +Data + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. +Initiation + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first recurring payment for a Standing Order schedule will be made. +Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RecurringPaymentDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Identification assigned by an institution to identify an account. This identification is known by the account owner. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides the details to identify the debtor account. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +The amount of the final Standing Order +FinalPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the first Standing Order +FirstPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the recurring Standing Order +RecurringPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticStandingOrderConsentResponse6.svg b/uml-diagrams/OBWriteDomesticStandingOrderConsentResponse6.svg new file mode 100644 index 00000000..35de0c43 --- /dev/null +++ b/uml-diagrams/OBWriteDomesticStandingOrderConsentResponse6.svg @@ -0,0 +1,753 @@ + + + + + + + + + + + + + +OBWriteDomesticStandingOrderConsentResponse6 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. +Initiation + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first recurring payment for a Standing Order schedule will be made. +Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RecurringPaymentDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Identification assigned by an institution to identify an account. This identification is known by the account owner. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +The amount of the final Standing Order +FinalPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the first Standing Order +FirstPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the recurring Standing Order +RecurringPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteDomesticStandingOrderResponse6.svg b/uml-diagrams/OBWriteDomesticStandingOrderResponse6.svg new file mode 100644 index 00000000..0207a253 --- /dev/null +++ b/uml-diagrams/OBWriteDomesticStandingOrderResponse6.svg @@ -0,0 +1,666 @@ + + + + + + + + + + + + + +OBWriteDomesticStandingOrderResponse6 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource. + +DomesticStandingOrderId [1..1] + + + +Type: string +Description: Specifies the status of the payment order resource. +Values: + - Cancelled + - InitiationCompleted + - InitiationFailed + - InitiationPending + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. +Initiation + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first recurring payment for a Standing Order schedule will be made. +Usage: This must be populated only if the first recurring date is different to the first payment date.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RecurringPaymentDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Identification assigned by an institution to identify an account. This identification is known by the account owner. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +The amount of the final Standing Order +FinalPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the first Standing Order +FirstPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +The amount of the recurring Standing Order +RecurringPaymentAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + +Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. +Refund + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteFile2.svg b/uml-diagrams/OBWriteFile2.svg new file mode 100644 index 00000000..7015c9bd --- /dev/null +++ b/uml-diagrams/OBWriteFile2.svg @@ -0,0 +1,221 @@ + + + + + + + + + + + + + +OBWriteFile2 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. +Initiation + + + +Type: number +Description: Total of all individual amounts included in the group, irrespective of currencies. + +ControlSum [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 44 +Description: A base64 encoding of a SHA256 hash of the file to be uploaded. + +FileHash [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Reference for the file. + +FileReference [0..1] + + + +Type: string +Description: Specifies the payment file type. +Values: + - UK.OBIE.PaymentInitiation.3.1 + - UK.OBIE.pain.001.001.08 + +FileType [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Description: Number of individual transactions contained in the payment information group. +Pattern: [0-9]{1,15} + +NumberOfTransactions [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteFileConsent3.svg b/uml-diagrams/OBWriteFileConsent3.svg new file mode 100644 index 00000000..e8bddaad --- /dev/null +++ b/uml-diagrams/OBWriteFileConsent3.svg @@ -0,0 +1,288 @@ + + + + + + + + + + + + + +OBWriteFileConsent3 + + + + + +Data + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. +Initiation + + + +Type: number +Description: Total of all individual amounts included in the group, irrespective of currencies. + +ControlSum [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 44 +Description: A base64 encoding of a SHA256 hash of the file to be uploaded. + +FileHash [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Reference for the file. + +FileReference [0..1] + + + +Type: string +Description: Specifies the payment file type. +Values: + - UK.OBIE.PaymentInitiation.3.1 + - UK.OBIE.pain.001.001.08 + +FileType [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Description: Number of individual transactions contained in the payment information group. +Pattern: [0-9]{1,15} + +NumberOfTransactions [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteFileConsentResponse4.svg b/uml-diagrams/OBWriteFileConsentResponse4.svg new file mode 100644 index 00000000..c70404db --- /dev/null +++ b/uml-diagrams/OBWriteFileConsentResponse4.svg @@ -0,0 +1,517 @@ + + + + + + + + + + + + + +OBWriteFileConsentResponse4 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - AwaitingUpload + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. +Initiation + + + +Type: number +Description: Total of all individual amounts included in the group, irrespective of currencies. + +ControlSum [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 44 +Description: A base64 encoding of a SHA256 hash of the file to be uploaded. + +FileHash [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Reference for the file. + +FileReference [0..1] + + + +Type: string +Description: Specifies the payment file type. +Values: + - UK.OBIE.PaymentInitiation.3.1 + - UK.OBIE.pain.001.001.08 + +FileType [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Description: Number of individual transactions contained in the payment information group. +Pattern: [0-9]{1,15} + +NumberOfTransactions [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteFileResponse3.svg b/uml-diagrams/OBWriteFileResponse3.svg new file mode 100644 index 00000000..f77bbc36 --- /dev/null +++ b/uml-diagrams/OBWriteFileResponse3.svg @@ -0,0 +1,493 @@ + + + + + + + + + + + + + +OBWriteFileResponse3 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource. + +FilePaymentId [1..1] + + + +Type: string +Description: Specifies the status of the payment order resource. +Values: + - InitiationCompleted + - InitiationFailed + - InitiationPending + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. +Initiation + + + +Type: number +Description: Total of all individual amounts included in the group, irrespective of currencies. + +ControlSum [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 44 +Description: A base64 encoding of a SHA256 hash of the file to be uploaded. + +FileHash [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: Reference for the file. + +FileReference [0..1] + + + +Type: string +Description: Specifies the payment file type. +Values: + - UK.OBIE.PaymentInitiation.3.1 + - UK.OBIE.pain.001.001.08 + +FileType [1..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +Description: Number of individual transactions contained in the payment information group. +Pattern: [0-9]{1,15} + +NumberOfTransactions [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteFundsConfirmationResponse1.svg b/uml-diagrams/OBWriteFundsConfirmationResponse1.svg new file mode 100644 index 00000000..12f48bdf --- /dev/null +++ b/uml-diagrams/OBWriteFundsConfirmationResponse1.svg @@ -0,0 +1,153 @@ + + + + + + + + + + + + + +OBWriteFundsConfirmationResponse1 + + + + + +Data + + + + +Result of a funds availability check. +FundsAvailableResult + + + +Type: boolean +Description: Flag to indicate the availability of funds given the Amount in the consent request. + +FundsAvailable [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the funds availability check was generated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FundsAvailableDateTime [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternational3.svg b/uml-diagrams/OBWriteInternational3.svg new file mode 100644 index 00000000..35135f7b --- /dev/null +++ b/uml-diagrams/OBWriteInternational3.svg @@ -0,0 +1,740 @@ + + + + + + + + + + + + + +OBWriteInternational3 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalConsent5.svg b/uml-diagrams/OBWriteInternationalConsent5.svg new file mode 100644 index 00000000..109fa4df --- /dev/null +++ b/uml-diagrams/OBWriteInternationalConsent5.svg @@ -0,0 +1,817 @@ + + + + + + + + + + + + + +OBWriteInternationalConsent5 + + + + + +Data + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalConsentResponse6.svg b/uml-diagrams/OBWriteInternationalConsentResponse6.svg new file mode 100644 index 00000000..f938aa80 --- /dev/null +++ b/uml-diagrams/OBWriteInternationalConsentResponse6.svg @@ -0,0 +1,1120 @@ + + + + + + + + + + + + + +OBWriteInternationalConsentResponse6 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +Further detailed information on the exchange rate that has been used in the payment transaction. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [1..1] + + + +Type: string +Format: date-time +Description: Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalResponse5.svg b/uml-diagrams/OBWriteInternationalResponse5.svg new file mode 100644 index 00000000..ecb0cccd --- /dev/null +++ b/uml-diagrams/OBWriteInternationalResponse5.svg @@ -0,0 +1,1304 @@ + + + + + + + + + + + + + +OBWriteInternationalResponse5 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource. + +InternationalPaymentId [1..1] + + + +Type: string +Description: Specifies the status of the payment information group. +Values: + - AcceptedCreditSettlementCompleted + - AcceptedSettlementCompleted + - AcceptedSettlementInProcess + - AcceptedWithoutPosting + - Pending + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +Further detailed information on the exchange rate that has been used in the payment transaction. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [1..1] + + + +Type: string +Format: date-time +Description: Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + + +Refund + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution. +Agent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Set of elements used to identify a person or an organisation. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalScheduled3.svg b/uml-diagrams/OBWriteInternationalScheduled3.svg new file mode 100644 index 00000000..da363321 --- /dev/null +++ b/uml-diagrams/OBWriteInternationalScheduled3.svg @@ -0,0 +1,751 @@ + + + + + + + + + + + + + +OBWriteInternationalScheduled3 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalScheduledConsent5.svg b/uml-diagrams/OBWriteInternationalScheduledConsent5.svg new file mode 100644 index 00000000..a8da83c1 --- /dev/null +++ b/uml-diagrams/OBWriteInternationalScheduledConsent5.svg @@ -0,0 +1,837 @@ + + + + + + + + + + + + + +OBWriteInternationalScheduledConsent5 + + + + + +Data + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalScheduledConsentResponse6.svg b/uml-diagrams/OBWriteInternationalScheduledConsentResponse6.svg new file mode 100644 index 00000000..a3df8a5e --- /dev/null +++ b/uml-diagrams/OBWriteInternationalScheduledConsentResponse6.svg @@ -0,0 +1,1140 @@ + + + + + + + + + + + + + +OBWriteInternationalScheduledConsentResponse6 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + +Type: string +Description: Specifies the status of consent resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +Further detailed information on the exchange rate that has been used in the payment transaction. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [1..1] + + + +Type: string +Format: date-time +Description: Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalScheduledResponse6.svg b/uml-diagrams/OBWriteInternationalScheduledResponse6.svg new file mode 100644 index 00000000..67c238ee --- /dev/null +++ b/uml-diagrams/OBWriteInternationalScheduledResponse6.svg @@ -0,0 +1,1313 @@ + + + + + + + + + + + + + +OBWriteInternationalScheduledResponse6 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedExecutionDateTime [0..1] + + + +Type: string +Format: date-time +Description: Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpectedSettlementDateTime [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource. + +InternationalScheduledPaymentId [1..1] + + + +Type: string +Description: Specifies the status of the payment order resource. +Values: + - Cancelled + - InitiationCompleted + - InitiationFailed + - InitiationPending + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +Further detailed information on the exchange rate that has been used in the payment transaction. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [1..1] + + + +Type: string +Format: date-time +Description: Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. +Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. +OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. + +EndToEndIdentification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. +Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. + +InstructionIdentification [1..1] + + + +Type: string +Description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. +Values: + - Normal + - Urgent + +InstructionPriority [0..1] + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +Format: date-time +Description: Date at which the initiating party requests the clearing agent to process the payment. +Usage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +RequestedExecutionDateTime [1..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Financial institution servicing an account for the creditor. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Provides details on the currency exchange rate and contract. +ExchangeRateInformation + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. + +ContractIdentification [0..1] + + + +Type: number +Description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. + +ExchangeRate [0..1] + + + +Type: string +Description: Specifies the type used to complete the currency exchange. +Values: + - Actual + - Agreed + - Indicative + +RateType [1..1] + + + +Type: string +Description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. +Pattern: ^[A-Z]{3,3}$ + +UnitCurrency [1..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. +RemittanceInformation + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. +OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. + +Reference [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. + +Unstructured [0..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + + +Refund + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution. +Agent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Set of elements used to identify a person or an organisation. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalStandingOrder4.svg b/uml-diagrams/OBWriteInternationalStandingOrder4.svg new file mode 100644 index 00000000..4138931f --- /dev/null +++ b/uml-diagrams/OBWriteInternationalStandingOrder4.svg @@ -0,0 +1,686 @@ + + + + + + + + + + + + + +OBWriteInternationalStandingOrder4 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Provides the details to identify the debtor account. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalStandingOrderConsent6.svg b/uml-diagrams/OBWriteInternationalStandingOrderConsent6.svg new file mode 100644 index 00000000..f8c52aa4 --- /dev/null +++ b/uml-diagrams/OBWriteInternationalStandingOrderConsent6.svg @@ -0,0 +1,772 @@ + + + + + + + + + + + + + +OBWriteInternationalStandingOrderConsent6 + + + + + +Data + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Provides the details to identify the debtor account. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalStandingOrderConsentResponse7.svg b/uml-diagrams/OBWriteInternationalStandingOrderConsentResponse7.svg new file mode 100644 index 00000000..f446b7dd --- /dev/null +++ b/uml-diagrams/OBWriteInternationalStandingOrderConsentResponse7.svg @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + +OBWriteInternationalStandingOrderConsentResponse7 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +Format: date-time +Description: Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CutOffDateTime [0..1] + + + +Type: string +Description: Specifies the Open Banking service request types. +Values: + - Create + +Permission [1..1] + + + +Type: string +Description: Specifies to share the refund account details with PISP +Values: + - No + - Yes + +ReadRefundAccount [0..1] + + + +Type: string +Description: Specifies the status of resource in code form. +Values: + - Authorised + - AwaitingAuthorisation + - Consumed + - Rejected + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +The authorisation type request from the TPP. +Authorisation + + + +Type: string +Description: Type of authorisation flow requested. +Values: + - Any + - Single + +AuthorisationType [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CompletionDateTime [0..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +Supporting Data provided by TPP, when requesting SCA Exemption. +SCASupportData + + + +Type: string +MaxLength: 40 +Description: Specifies a character string with a maximum length of 40 characters. +Usage: This field indicates whether the PSU was subject to SCA performed by the TPP +Values: + - CA + - SCA + +AppliedAuthenticationApproach [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId + +ReferencePaymentOrderId [0..1] + + + +Type: string +Description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation +Values: + - BillPayment + - ContactlessTravel + - EcommerceGoods + - EcommerceServices + - Kiosk + - Parking + - PartyToParty + +RequestedSCAExemptionType [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + +The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments. +Risk + + + +Type: string +MinLength: 3 +MaxLength: 4 +Description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. + +MerchantCategoryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: The unique customer identifier of the PSU with the merchant. + +MerchantCustomerIdentification [0..1] + + + +Type: string +Description: Specifies the payment context +Values: + - BillPayment + - EcommerceGoods + - EcommerceServices + - Other + - PartyToParty + +PaymentContextCode [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services or in free format text. +DeliveryAddress + + + + +AddressLine [0..2] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government, occupying a particular territory. +Pattern: ^[A-Z]{2,2}$ + +Country [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [1..1] + + + + + +1..1 + + + +0..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWriteInternationalStandingOrderResponse7.svg b/uml-diagrams/OBWriteInternationalStandingOrderResponse7.svg new file mode 100644 index 00000000..7641f08c --- /dev/null +++ b/uml-diagrams/OBWriteInternationalStandingOrderResponse7.svg @@ -0,0 +1,1173 @@ + + + + + + + + + + + + + +OBWriteInternationalStandingOrderResponse7 + + + + + +Data + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource. + +ConsentId [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +CreationDateTime [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 40 +Description: OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource. + +InternationalStandingOrderId [1..1] + + + +Type: string +Description: Specifies the status of resource in code form. +Values: + - Cancelled + - InitiationCompleted + - InitiationFailed + - InitiationPending + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Set of elements used to provide details of a charge for the payment initiation. +Charges + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [1..1] + + + +Type: string +Description: Charge type, in a coded form. +Values: + - UK.OBIE.CHAPSOut + +Type [1..1] + + + + +Amount of money associated with the charge type. +Amount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +^ Only incuded in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. +Debtor + + + +Type: string +Description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text + +Identification [1..1] + + + +Type: string +Description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. + +Name [1..1] + + + +Type: string +Description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code + +SchemeName [1..1] + + + +Type: string +Description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text + +SecondaryIdentification [0..1] + + + + +The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order. +Initiation + + + +Type: string +Description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. +Values: + - BorneByCreditor + - BorneByDebtor + - FollowingServiceLevel + - Shared + +ChargeBearer [0..1] + + + +Type: string +Description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. +Pattern: ^[A-Z]{3,3}$ + +CurrencyOfTransfer [1..1] + + + +Type: string +Description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). +Pattern: [A-Z]{2,2} + +DestinationCountryCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. + +ExtendedPurpose [0..1] + + + +Type: string +Format: date-time +Description: The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FinalPaymentDateTime [0..1] + + + +Type: string +Format: date-time +Description: The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstPaymentDateTime [1..1] + + + +Type: string +Description: Individual Definitions: +EvryDay - Every day +EvryWorkgDay - Every working day +IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) +WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) +IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) +QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). +ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. +SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. +RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. +Individual Patterns: +EvryDay (ScheduleCode) +EvryWorkgDay (ScheduleCode) +IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) +WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) +IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) +QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay +The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: +EvryDay +EvryWorkgDay +IntrvlWkDay:0[1-9]:0[1-7] +WkInMnthDay:0[1-5]:0[1-7] +IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) +QtrDay:(ENGLISH|SCOTTISH|RECEIVED) +Full Regular Expression: +^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ +Pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ + +Frequency [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. + +NumberOfPayments [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 4 +Description: Specifies the external purpose code in the format of character string with a maximum length of 4 characters. +The list of valid codes is an external code list published separately. +External code sets can be downloaded from www.iso20022.org. + +Purpose [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. +Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. +If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. + +Reference [0..1] + + + + +Party to which an amount of money is due. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Provides the details to identify the beneficiary account. +CreditorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level. +Note, the account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. +This is the servicer of the beneficiary account. +CreditorAgent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of the servicing institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. +DebtorAccount + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. +Note, the account name is not the product name or the nickname of the account. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. +Usage: This amount has to be transported unchanged through the transaction chain. +InstructedAmount + + + +Type: string +Description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. +Pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ + +Amount [1..1] + + + +Type: string +Description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". +Pattern: ^[A-Z]{3,3}$ + +Currency [1..1] + + + + +Additional information that can not be captured in the structured fields and/or any other specific block. +SupplementaryData + + + + +The multiple authorisation flow response from the ASPSP. +MultiAuthorisation + + + +Type: string +Format: date-time +Description: Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +ExpirationDateTime [0..1] + + + +Type: string +Format: date-time +Description: Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastUpdateDateTime [0..1] + + + +Type: integer +Description: Number of authorisations received. + +NumberReceived [0..1] + + + +Type: integer +Description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). + +NumberRequired [0..1] + + + +Type: string +Description: Specifies the status of the authorisation flow in code form. +Values: + - Authorised + - AwaitingFurtherAuthorisation + - Rejected + +Status [1..1] + + + + + +Refund + + + + +Provides the details to identify an account. +Account + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Identification assigned by an institution to identify an account. This identification is known by the account owner. + +Identification [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name of the account, as assigned by the account servicing institution. +Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. +OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. + +Name [1..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BBAN + - UK.OBIE.IBAN + - UK.OBIE.PAN + - UK.OBIE.Paym + - UK.OBIE.SortCodeAccountNumber + +SchemeName [1..1] + + + +Type: string +MinLength: 1 +MaxLength: 34 +Description: This is secondary identification of the account, as assigned by the account servicing institution. +This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). + +SecondaryIdentification [0..1] + + + + +Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution. +Agent + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. + +Identification [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 140 +Description: Name by which an agent is known and which is usually used to identify that agent. + +Name [0..1] + + + +Type: string +Description: Name of the identification scheme, in a coded form as published in an external list. +Values: + - UK.OBIE.BICFI + +SchemeName [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Set of elements used to identify a person or an organisation. +Creditor + + + +Type: string +MinLength: 1 +MaxLength: 350 +Description: Name by which a party is known and which is usually used to identify that party. + +Name [0..1] + + + + +Information that locates and identifies a specific address, as defined by postal services. +PostalAddress + + + + +AddressLine [0..7] + + + +Type: string +Description: Identifies the nature of the postal address. +Values: + - Business + - Correspondence + - DeliveryTo + - MailTo + - POBox + - Postal + - Residential + - Statement + +AddressType [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Number that identifies the position of a building on a street. + +BuildingNumber [0..1] + + + +Type: string +Description: Nation with its own government. +Pattern: ^[A-Z]{2,2}$ + +Country [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Identifies a subdivision of a country such as state, region, county. + +CountrySubDivision [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a division of a large organisation or building. + +Department [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 16 +Description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. + +PostCode [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Name of a street or thoroughfare. + +StreetName [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 70 +Description: Identification of a sub-division of a large organisation or building. + +SubDepartment [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 35 +Description: Name of a built-up area, with defined boundaries, and a local government. + +TownName [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +1..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +1..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file diff --git a/uml-diagrams/OBWritePaymentDetailsResponse1.svg b/uml-diagrams/OBWritePaymentDetailsResponse1.svg new file mode 100644 index 00000000..932e9624 --- /dev/null +++ b/uml-diagrams/OBWritePaymentDetailsResponse1.svg @@ -0,0 +1,237 @@ + + + + + + + + + + + + + +OBWritePaymentDetailsResponse1 + + + + + +Data + + + + +Payment status details. +PaymentStatus + + + +Type: string +MinLength: 1 +MaxLength: 210 +Description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. + +PaymentTransactionId [1..1] + + + +Type: string +Description: Status of a transfe, as assigned by the transaction administrator. +Values: + - Accepted + - AcceptedCancellationRequest + - AcceptedCreditSettlementCompleted + - AcceptedCustomerProfile + - AcceptedFundsChecked + - AcceptedSettlementCompleted + - AcceptedSettlementInProcess + - AcceptedTechnicalValidation + - AcceptedWithChange + - AcceptedWithoutPosting + - Cancelled + - NoCancellationProcess + - PartiallyAcceptedCancellationRequest + - PartiallyAcceptedTechnicalCorrect + - PaymentCancelled + - Pending + - PendingCancellationRequest + - Received + - Rejected + - RejectedCancellationRequest + +Status [1..1] + + + +Type: string +Format: date-time +Description: Date and time at which the status was assigned to the transfer.All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +StatusUpdateDateTime [1..1] + + + + +Payment status details as per underlying Payment Rail. +StatusDetail + + + +Type: string +Description: User community specific instrument. +Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. +Values: + - UK.OBIE.BACS + - UK.OBIE.BalanceTransfer + - UK.OBIE.CHAPS + - UK.OBIE.Euro1 + - UK.OBIE.FPS + - UK.OBIE.Link + - UK.OBIE.MoneyTransfer + - UK.OBIE.Paym + - UK.OBIE.SEPACreditTransfer + - UK.OBIE.SEPAInstantCreditTransfer + - UK.OBIE.SWIFT + - UK.OBIE.Target2 + +LocalInstrument [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 128 +Description: Status of a transfer, as assigned by the transaction administrator. + +Status [1..1] + + + +Type: string +Description: Reason Code provided for the status of a transfer. +Values: + - Cancelled + - PendingFailingSettlement + - PendingSettlement + - Proprietary + - ProprietaryRejection + - Suspended + - Unmatched + +StatusReason [0..1] + + + +Type: string +MinLength: 1 +MaxLength: 256 +Description: Reason provided for the status of a transfer. + +StatusReasonDescription [0..1] + + + + +Links relevant to the payload +Links + + + +Type: string +Format: uri + +First [0..1] + + + +Type: string +Format: uri + +Last [0..1] + + + +Type: string +Format: uri + +Next [0..1] + + + +Type: string +Format: uri + +Prev [0..1] + + + +Type: string +Format: uri + +Self [1..1] + + + + +Meta Data relevant to the payload +Meta + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +FirstAvailableDateTime [0..1] + + + +Type: string +Format: date-time +Description: All dates in the JSON payloads are represented in ISO 8601 date-time format. +All date-time fields in responses must include the timezone. An example is below: +2017-04-05T10:43:07+00:00 + +LastAvailableDateTime [0..1] + + + +Type: integer +Format: int32 + +TotalPages [0..1] + + + + + +1..1 + + + +0..* + + + +0..1 + + + +0..1 + + + +0..1 \ No newline at end of file