Namespaced Enumerations - v3.1.2

Version Control

Version
Date
Author
Comments
3.1 OB R/W API TeamThis is the baseline version.
4.0-draft1

 

OB R/W API Team

Errata:

  • Typos in enumeration descriptions and sections.

v4.0-draft1 changes:

  • Added Error Response codes (OBErrorResponseType1Code) from R/W page.
  • Added UK.OBIE.Rules.DuplicateReference to OBErrorResponseError1Code.
  • Minor amendment in the description UK.OBIE.Resource.InvalidFormat.
  • Incorporated agreed behaviour from Decision /wiki/spaces/WOR/pages/748748804 - added error code - "UK.OBIE.Reauthenticate"
4.0-draft3 OB R/W API Team

v4.0-draft3 changes:

  • Adde OBEventType1Code.
  • Updated UK.OBIE.PaymentInitiation file format to 4.0.
  • Added UK.OBIE.BeneficiaryId as the one of the values for CreditorAccount/SchemeName enumeration - OBExternalAccountIdentification4Code
4.0-draft4 OB R/W API Team

v4.0-draft4 changes:

  • Removed UK.OBIE.BeneficiaryId from OBExternalAccountIdentification4Code enumerations.
4.0-draft7 OB R/W API Team

v4.0-draft7 changes:

  • Added the following enums:
    • OBExternalEventConsentAuthorizationRevokedReason1Code
    • OBExternalEventAccountAccessConsentLinkedAccountUpdateReason1Code
    • OBExternalStatementFeeRateType1Code
    • OBExternalStatementFeeFrequency1Code
    • OBExternalStatementInterestRateType1Code
    • OBExternalStatementInterestFrequency1Code
    • OBExternalLegalStructureType1Code
    • OBExternalAccountRole1Code
3.1.2-RC1 OB R/W API Team

v3.1.2-RC1 changes:

  • Added UK.OBIE.Unsupported.EventType to OBErrorResponseError1Code.
  • Renamed version to 3.1.2

Overview

The specification defines certain fields with only a fixed set of possible values as enumerations, and further additions to possible values require a Specification change.

As part of Version 3 OBIE Specifications defined new custom Data Types, which are an extendable list of enumerated values. Any extensions to this standard list of values can be done by the ASPSPs, with relevant documentation on their Developer Portals.

The extendable Data Type values are namespaced, to help identify the issuer of the value, and the relevant value.

Basics

These Data Types, in general, are called namespaced enumerations.

Specific API Data Dictionary will define a custom Data Type class, which will help lookup the OBIE defined standard set of namespaced enumerations in this specification page as well as respective swagger files.

The namespaced enumeration values specified by Open Banking are documented here and will be prefixed by UK.OBIE. 

Design Principles

When extending a namespaced enumeration:

  1. ASPSPs must not publish an ASPSP-specific enumerated value where a generic OBIE defined enumerated value may be used.
  2. ASPSPs must place such values in a namespace consisting of their two-letter country code (ISO 3166-1 Alpha-2 code), followed by a full-stop, followed by their name. e.g.
    1. UK.Barclays.PingIt
    2. KE.Safaricom.M-Pesa

Release Management

Usage of non-namespaced values may be discontinued in a future version of this standard. 

As a special case and in order to minimise disruption between versions of the standard, a TPP may specify previous non-namespaces values, e.g. IBAN instead of UK.OBIE.IBAN.

In ASPSP generated responses, however, an ASPSP must always respond with fully namespaced values.

Common Namespaced Enumerations

The following namespaced enumerations are used across all the standards.

OBExternalAccountIdentification4Code

This is Data Type for Account/SchemeName and used to identify the type of Identification used to identify an account.

CodeDescription

UK.OBIE.BBAN

Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
UK.OBIE.IBANAn identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616. "Banking and related financial services - International Bank Account Number (IBAN)".
UK.OBIE.PANPrimary Account Number - identifier scheme used to identify a card account.
UK.OBIE.PaymPaym Scheme to make payments via mobile
UK.OBIE.SortCodeAccountNumberSort Code and Account Number - identifier scheme used in the UK by financial institutions to identify the account of a customer. The identifier is the concatenation of the 6 digit UK sort code and 8 digit account number.
The regular expression for this identifier is: ^[0-9]{6}[0-9]{8}$

OBExternalFinancialInstitutionIdentification4Code

This is the Data Type for Agent/SchemeName and used to identify the type of Identification used to identify an agent. 

CodeDescription
UK.OBIE.BICFIValid BICs for financial institutions are registered by the ISO 9362 Registration Authority in the BIC directory, and consist of eight (8) or eleven (11) contiguous characters.

OBErrorResponseError1Code

This is Data Type gives a low level textual error code to help categorise an error response. The applicable HTTP response code is also given.

 Show
Code 
HTTP Status Category
Description
UK.OBIE.Field.Expected400

For the scenario, when a field-value is not provided in the payload, that is expected in combination with preceding field-value pairs.

The corresponding path must be populated with the path of the unexpected field.

E.g.

ExchangeRate must be specified with Agreed RateType. ExchangeRate should be specified in the path element.

InstructionPriority must be specified with Agreed RateType. InstructionPriority should be specified in the path element.

UK.OBIE.Field.Invalid400An invalid value is supplied in one of the fields. Reference of the invalid field should be provided in the path field, and the URL field may have the link to a website explaining the valid behaviour. The error message should describe the problem in detail.
UK.OBIE.Field.InvalidDate400An invalid date is supplied e.g. when a future date is expected, a date in past or current date is supplied. The message can specify the actual problem with the date. The reference of the invalid field should be provided in the path field, and URL field may have the link to a website explaining the valid behaviour
UK.OBIE.Field.Missing400

A mandatory field, required for the API, is missing from the payload. This error code can be used, if it is not already captured under the validation for UK.OBIE.Resource.InvalidFormat.

Reference of the missing field should be provided in the path field, and URL field may have the link to a website explaining the valid behaviour

UK.OBIE.Field.Unexpected400

For the scenario, when a field-value is provided in the payload, that is not expected in combination with preceding field-value pairs. E.g.

ContractIdentification must not be specified with [Actual/Indicative] RateType. ContractIdentification should be specified in the path element
ExchangeRate must not be specified with [Actual/Indicative] RateType. ExchangeRate should be specified in the path element.
InstructionPriority must not be specified with LocalInstrument. InstructionPriority should be specified in the path element.

UK.OBIE.Header.Invalid400An invalid value is supplied in the HTTP header. The HTTP Header should be specified in the path element.
UK.OBIE.Header.Missing400A required HTTP header has not been provided. The HTTP Header should be specified in the path element.
UK.OBIE.Resource.ConsentMismatch400

{payment-order-consent} and {payment-order} resource mismatch. For example, if an element in the resource’s Initiation or Risk section does not match the consent section. 

The path element should be populated with the field of the resource that does not match the consent.

UK.OBIE.Resource.InvalidConsentStatus400

The resource’s associated consent is not in a status that would allow the resource to be created, or a request to be executed.

E.g., if a consent resource had a status of AwaitingAuthorisation or Rejected, a resource could not be created against this consent.

The path element should be populated with the field in the consent resource that is invalid.

UK.OBIE.Resource.InvalidFormat400When the Payload schema does not match to the endpoint, e.g., /domestic-payments endpoint is called with a JSON Payload, which cannot be parsed into a class such as OBWriteDomestic1
UK.OBIE.Resource.NotFound400Returned when a resource with the specified Id does not exist (and hence could not be operated upon). 
UK.OBIE.Rules.AfterCutOffDateTime400{payment-order} consent / resource received after CutOffDateTime
UK.OBIE.Rules.DuplicateReference400A duplicate reference has been used for a CBPII confirmation of funds request.
UK.OBIE.Signature.Invalid400The signature header x-jws-signature was parsed and has a valid JOSE header that complies with the specification. However, the signature itself could not be verified.
UK.OBIE.Signature.InvalidClaim400The JOSE header in the x-jws-signature has one or more claims with an invalid value. (e.g. a kid that does not resolve to a valid certificate). The name of the missing claim should be specified in the path field of the error response.
UK.OBIE.Signature.MissingClaim400The JOSE header in the x-jws-signature has one or more mandatory claim(s) that are not specified. The name of the missing claim(s) should be specified in the path field of the error response.
UK.OBIE.Signature.Malformed400The x-jws-signature in the request header was malformed and could not be parsed as a valid JWS.
UK.OBIE.Signature.Missing400The API request expected an x-jws-signature in the header, but it was missing.
UK.OBIE.Signature.Unexpected400The API request was not expecting to receive an x-jws-signature in the header, but the TPP made a request that included an x-jws-signature.
UK.OBIE.Unsupported.AccountIdentifier400

The account identifier is unsupported for the given scheme.

The path element should be populated with the path of the AccountIdentifier.

UK.OBIE.Unsupported.AccountSecondaryIdentifier400

The account secondary identifier is unsupported for the given scheme. 

The path element should be populated with the path of the AccountSecondaryIdentifier.

UK.OBIE.Unsupported.Currency400

The currency is not supported. Use UK.OBIE.Field.Invalid for invalid Currency.

The path element should be populated with the path of the Currency.

The URL should be populated with a link to ASPSP documentation listing out the supported currencies.

UK.OBIE.Unsupported.EventType400

Event Type is not supported.

The path element should be populated with the path of the EventType.

The URL should be populated with a link to ASPSP documentation listing out the supported Event Types.

UK.OBIE.Unsupported.Frequency400

Frequency is not supported.  

The path element should be populated with the path of the Frequency.

The URL should be populated with a link to ASPSP documentation listing out the supported frequencies.

UK.OBIE.Unsupported.LocalInstrument400

LocalInstrument is not supported by the ASPSP. 

The path element should be populated with the path of the LocalInstrument.

The URL should be populated with a link to ASPSP documentation listing out the supported local instruments.

UK.OBIE.Unsupported.Scheme400

Identification scheme is not supported. 

The path element should be populated with the path of the scheme.

The URL should be populated with a link to ASPSP documentation listing out the supported schemes.

UK.OBIE.Reauthenticate403The ASPSP must use this error code in Error Response to indicate that re-authentication by the PSU is required to process the request.
UK.OBIE.UnexpectedError5xx

An error code that can be used, when an unexpected error occurs.

The ASPSP must populate the message with a meaningful error description, without revealing sensitive information.



Account and Transaction API Namespaced Enumerations 

OBExternalStatementAmountType1Code


 Show


CodeDescription
UK.OBIE.ArrearsClosingBalanceThe balance that is in arrears at the end of the statement period.
UK.OBIE.AvailableBalanceThe available balance is the difference between the credit limit and the account balance – how much is available to spend.
UK.OBIE.AverageBalanceWhenInCreditThe average daily balance when the account is in credit during the statement period.
UK.OBIE.AverageBalanceWhenInDebitThe average daily balance when the account is in debit during the statement period.
UK.OBIE.AverageDailyBalanceThe average daily balance during the statement period. An average daily balance adds the closing balances at the end of each day in a given period of time and divides the sum by the number of calendar days in that period.
UK.OBIE.BalanceTransferClosingBalanceThe component of balance that relates to balance transfers at the end of the statement period.
UK.OBIE.CashClosingBalanceThe component of balance that relates to cash at the end of the statement period.
UK.OBIE.ClosingBalanceThe ending balance or closing balance at the end of the current statement period.
UK.OBIE.CreditLimitThe credit limit is the total amount of credit available to a borrower, including any amount already borrowed.
UK.OBIE.CurrentPaymentThe total payments received since the last period.
UK.OBIE.DirectDebitPaymentDueThe total direct debit payments due for current statement period.
UK.OBIE.FSCSInsuranceThe amount under which the FSCS scheme will protect consumers when authorised financial services firms fail.
UK.OBIE.MinimumPaymentDueThe minimum payment required for the current statement period.
UK.OBIE.PendingTransactionsBalanceThe total pending transactions balance at the end of the statement period.
UK.OBIE.PreviousClosingBalanceThe closing balance of the previous statement.
UK.OBIE.PreviousPaymentThe previous payment amount in the last statement period.
UK.OBIE.PurchaseClosingBalanceThe component of balance that relates to purchases at the end of the statement period.
UK.OBIE.StartingBalanceThe new balance or starting balance carried forward since last statement period.
UK.OBIE.TotalAdjustmentsTotal adjustments to the account during the statement period.
UK.OBIE.TotalCashAdvancesA cash advance is a short-term loan from a bank or alternative lender. The term also refers to a service provided by many credit card issuers allowing cardholders to withdraw a certain amount of cash. 
UK.OBIE.TotalChargesThe total charges including interest, late payment fee during the statement period.
UK.OBIE.TotalCreditsTotal amount credited in the account during the statement period.
UK.OBIE.TotalDebitsTotal amount debited (money taken out from account) from the account during the statement period.
UK.OBIE.TotalPurchasesThe total transactions made during that statement period.

OBExternalStatementBenefitType1Code


 Show
CodeDescription
UK.OBIE.CashbackCash back amount received during the statement period.
UK.OBIE.InsuranceInsurance amount during the statement period.
UK.OBIE.TravelDiscountTravel discount amount received during the statement period.
UK.OBIE.TravelInsuranceTravel insurance amount during the statement period.

OBExternalStatementDateTimeType1Code


 Show


CodeDescription 
UK.OBIE.BalanceTransferPromoEndThe date the balance transfer promo rate will end.
UK.OBIE.DirectDebitDueThe date that the direct debit payment is due for the current statement. 
UK.OBIE.LastPaymentThe date that an account holder must make the payment for the previous statement period. 
UK.OBIE.LastStatementThe date on which the last statement was made available to account holder.
UK.OBIE.NextStatementThe date on which the next statement will be made available to account holder.
UK.OBIE.PaymentDueThe date that an account holder must make the payment for the current statement period. 
UK.OBIE.PurchasePromoEndThe date the purchase promo rate will end.
UK.OBIE.StatementAvailableThe date on which the current statement was made available to account holder.

OBExternalStatementFeeType1Code


 Show


CodeDescription
UK.OBIE.AnnualAnnual fees charged during the statement period.
UK.OBIE.BalanceTransferBalance transfer fees charged during the statement period.
UK.OBIE.CashAdvanceCash advance fees charged during the statement period.
UK.OBIE.CashTransactionCash transaction fees charged during the statement period.
UK.OBIE.ForeignCashTransactionForeign cash transaction fees charged during the statement period.
UK.OBIE.ForeignTransactionForeign transaction fees charged during the statement period.
UK.OBIE.GamblingGambling transaction fees charged during the statement period.
UK.OBIE.LatePaymentLate payment fees charged during the statement period.
UK.OBIE.MoneyTransferMoney transfer fees charged during the statement period.
UK.OBIE.MonthlyMonthly account fees charged during the statement period.
UK.OBIE.OverlimitOver limit fees charged during the statement period..
UK.OBIE.PostalOrderPostal order fees charged during the statement period.
UK.OBIE.PrizeEntryPrize entry fees charged during the statement period.
UK.OBIE.StatementCopyStatement copy fees charged during the statement period.
UK.OBIE.TotalTotal fees charges during the statement period.

OBExternalStatementInterestType1Code


 Show
CodeDescription
UK.OBIE.BalanceTransferInterest on balance transfers.
UK.OBIE.CashInterest on cash advances.
UK.OBIE.EstimatedNextThe estimated interest that will be charged if the closing balance is not paid in full.
UK.OBIE.PurchaseInterest on purchases.
UK.OBIE.TotalTotal interest charges during the statement period.

OBExternalStatementRateType1Code


 Show
CodeDescription
UK.OBIE.AnnualBalanceTransferAnnual interest rate charged on balance transfer from other service provider.
UK.OBIE.AnnualBalanceTransferAfterPromoAnnual interest rate charged on balance transfer from other service provider after promotional period.
UK.OBIE.AnnualBalanceTransferPromoAnnual interest rate charged on balance transfer from other service provider during promotional period.
UK.OBIE.AnnualCashAnnual interest rate charged on cash advance.
UK.OBIE.AnnualPurchaseAnnual interest rate charged on purchases.
UK.OBIE.AnnualPurchaseAfterPromoAnnual interest rate charged on purchases from after promotional period.
UK.OBIE.AnnualPurchasePromoAnnual interest rate charged on purchases from during promotional period.
UK.OBIE.MonthlyBalanceTransferMonthly interest rate charged on balance transfer from other service provider.
UK.OBIE.MonthlyCashMonthly interest rate charged on cash advance.
UK.OBIE.MonthlyPurchaseMonthly interest rate charged on purchases.

OBExternalStatementValueType1Code


 Show
CodeDescription
UK.OBIE.AirMilesPointsAir miles points at the end of the statement period.
UK.OBIE.AirMilesPointsBalanceAir miles points at the end of the statement period.
UK.OBIE.CreditsTotal number of credits in statement period.
UK.OBIE.DebitsTotal number of debits in statement period.
UK.OBIE.HotelPointsHotel points at the end of the statement period.
UK.OBIE.HotelPointsBalanceHotel points at the end of the statement period.
UK.OBIE.RetailShoppingPointsRetail shopping points at the end of the statement period.
UK.OBIE.RetailShoppingPointsBalanceRetail shopping points at the end of the statement period.

OBExternalStatementFeeRateType1Code


 Show
CodeDescription
UK.OBIE.AERThe 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.
UK.OBIE.EAREAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently
used interchangeably), being the actual annual interest rate of an Overdraft.

OBExternalStatementFeeFrequency1Code


 Show
CodeDescription
UK.OBIE.ChargingPeriodThis fee is triggered at the end of each charging period.
UK.OBIE.PerTransactionAmountThe amount stated is levied for each transaction processed.
UK.OBIE.PerTransactionPercentageThe fee amount is the given percentage of the transaction processed and is levied for each transaction.
UK.OBIE.StatementMonthlyThis fee is triggered based on a monthly statement period.
UK.OBIE.QuarterlyThis fee is triggered at the end of every quarter.
UK.OBIE.WeeklyThe fee is triggered weekly.

OBExternalStatementInterestRateType1Code


 Show
CodeDescription
UK.OBIE.BOEBaseRateInterest rate shown is linked to the Bank of England Base Rate shown at http://www.bankofengland.co.uk/Pages/home.aspx. Typically defined as a % above the 'Current Bank Rate', but may also be below or equal to bank rate for certain Loan products.
UK.OBIE.FixedRateFixed rate.
UK.OBIE.GrossInterest rate shown is before any tax deducted.
UK.OBIE.LoanProviderBaseRateLoan provider base rate.
UK.OBIE.NetInterest rate shown is after tax is deducted.

OBExternalStatementInterestFrequency1Code


 Show
CodeDescription
UK.OBIE.DailyCalculated and/or applied daily.
UK.OBIE.HalfYearlyCalculated and/or applied half yearly.
UK.OBIE.MonthlyCalculated and/or applied monthly.
UK.OBIE.PerStatementDateCalculated and/or applied on the statement date.
UK.OBIE.QuarterlyThis fee is triggered at the end of every quarter.
UK.OBIE.WeeklyThe fee is triggered weekly.
UK.OBIE.YearlyCalculated and/or applied annually.

OBExternalLegalStructureType1Code


 Show
CodeDescription
UK.OBIE.IndividualIndividual
UK.OBIE.CICCommunity Interest Company
UK.OBIE.CIOCharitable Incorporated Organisation
UK.OBIE.CoOpCo-operative
UK.OBIE.CharityCharity
UK.OBIE.GeneralPartnershipGeneral Partnership
UK.OBIE.LimitedLiabilityPartnershipLimited Liability Partnership
UK.OBIE.ScottishLimitedPartnershipScottish Limited Partnership
UK.OBIE.LimitedPartnershipLimited Partnership
UK.OBIE.PrivateLimitedCompanyPrivate Limited Company
UK.OBIE.PublicLimitedCompanyPublic Limited Company
UK.OBIE.SoleSole (sole trader)

OBExternalAccountRole1Code


 Show
CodeDescription
UK.OBIE.PrincipalPrincipal
UK.OBIE.SecondaryOwnerSecondary owner
UK.OBIE.BeneficiaryBeneficiary
UK.OBIE.PowerOfAttorneyPower of attorney
UK.OBIE.LegalGuardianLegal guardian
UK.OBIE.CustodianForMinorCustodian for minor
UK.OBIE.SuccessorOnDeathSuccessor on death
UK.OBIE.AdministratorAdministrator
UK.OBIE.OtherPartyOther party
UK.OBIE.GranterGranter
UK.OBIE.SettlorSettlor
UK.OBIE.SeniorManagingOfficialSenior managing official
UK.OBIE.ProtectorProtector
UK.OBIE.RegisteredShareholderNameRegistered shareholder name

Payment Initiation API Namespaced Enumerations

OBExternalLocalInstrument1Code


 Show

This field is used to indicate the ASPSP's payment service to be used for making a payment.

CodeDescription
UK.OBIE.BACSBack Payment Scheme
UK.OBIE.CHAPSCHAPS Payment Scheme
UK.OBIE.FPSFaster Payment Scheme
UK.OBIE.SWIFTSwift Payment Service
UK.OBIE.BalanceTransferTo indicate Balance Transfer
UK.OBIE.MoneyTransferTo Indicate Money Transfer
UK.OBIE.PaymPaym Payment
UK.OBIE.Euro1To use Euro1 Payment System 
UK.OBIE.SEPACreditTransferTo indicate SEPA Credit Transfer payment service
UK.OBIE.SEPAInstantCreditTransferTo indicate SEPA Instant Credit Transfer payment service
UK.OBIE.LinkTo indicate Link payment service
UK.OBIE.Target2To indicate Target2 payment service

OBExternalPaymentChargeType1Code


 Show

This field is used to indicate the type of fee/charge to be applied to the payment-order.

The enumerated values specified by Open Banking align with the OBIE Open Data Standard.

This enumeration consists of a subset of the fees and charges identified in the Open Data Standard. The subset is limited to fees and charges associated with payments.

CodeDescription

UK.OBIE.CHAPSOut

CHAPS Payment Service fee

UK.OBIE.BalanceTransferOut

Balance Transfer Service fee
UK.OBIE.MoneyTransferOutMoney Transfer Service fee

OBExternalFileType1Code


 Show

This field is used to indicate the file-type that is being submitted as part of a file-payment payload. 

CodeDescription

UK.OBIE.pain.001.001.08

This is specified when a fully compliant pain.001 XML file is staged for the payment initiation.

UK.OBIE.PaymentInitiation.4.0

This is specified when an array of payments, which are compliant with the OBIE Initiation objects in the v4.0 standard, are staged in a .json file for the payment initiation.


Confirmation of Funds API Namespaced Enumerations

None

Event Notification API Namespaced Enumerations

OBEventType1Code


 Show

This field is used to indicate the event types a TPP would like to subscribe to as part of the callback-urls payload.

CodeDescription
UK.OBIE.Resource-UpdateAn event that indicates a resource has been updated.

UK.OBIE.Consent-Authorization-Revoked

An event that indicates a consent resource has had its authorisation revoked.

UK.OBIE.Acount-Access-Consent-Linked-Account-Update

An event that indicates an account linked to a consent has move in/out of scope of the consent.

OBExternalEventConsentAuthorizationRevokedReason1Code


 Show

This field is used to indicate the reason associated with a Consent Authorization Revoked event.

No UK.OBIE codes have been defined for this event.

OBExternalEventAccountAccessConsentLinkedAccountUpdateReason1Code


 Show

This field is used to indicate the reason associated with an Account Access Consent Linked Account Update event.

CodeDescription
UK.OBIE.AccountClosureAn account is no longer associated with the consent as it has been closed.
UK.OBIE.CASS

An account is no longer associated with the consent as it has been switched (using the Current Account Switch Service) to another ASPSP.