Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device.
Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Extracted name-spaced enumerations into a dedicated page for Single Point of Reference
3.1-draft4
Nov 1, 2018
OB R/W API Team
Draft4 Changes:
Typos
3.1-rc1
Nov 13, 2018
OB R/W API Team
RC1 Changes:
Reworded for clarity, no substantial changes.
Added UK.OBIE.BalanceTransferOut and UK.OBIE.MoneyTransferOut to OBExternalPaymentChargeType1Code namespaced enumeration.
3.1
Nov 30, 2018
OB R/W API Team
Version 3.1 final release.
No changes from Version 3.1 RC1.
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:
ASPSPs must not publish an ASPSP-specific enumerated value where a generic OBIE defined enumerated value may be used.
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.
UK.Barclays.PingIt
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 minimize 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.
Code
Description
Code
Description
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.IBAN
An 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.PAN
Primary Account Number - identifier scheme used to identify a card account.
UK.OBIE.Paym
Paym Scheme to make payments via mobile
UK.OBIE.SortCodeAccountNumber
Sort 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.
Code
Description
Code
Description
UK.OBIE.BICFI
Valid 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.
Account and Transaction API Namespaced Enumerations
OBExternalStatementAmountType1Code
Code
Description
Code
Description
UK.OBIE.ArrearsClosingBalance
The balance that is in arrears at the end of the statement period.
UK.OBIE.AvailableBalance
The available balance is the difference between the credit limit and the account balance – how much is avaialble to spend.
UK.OBIE.AverageBalanceWhenInCredit
The average daily balance when the account is in crebit during the statement period.
UK.OBIE.AverageBalanceWhenInDebit
The average daily balance when the account is in debit during the statement period.
UK.OBIE.AverageDailyBalance
The 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.BalanceTransferClosingBalance
The component of balance that relates to balance transfers at the end of the statement period.
UK.OBIE.CashClosingBalance
The component of balance that relates to cash at the end of the statement period.
UK.OBIE.ClosingBalance
The ending balance or closing balance at the end of the current statement period.
UK.OBIE.CreditLimit
The credit limit is the total amount of credit available to a borrower, including any amount already borrowed.
UK.OBIE.CurrentPayment
The total payments received since the last period.
UK.OBIE.DirectDebitPaymentDue
The total direct debit payments due for current statement period.
UK.OBIE.FSCSInsurance
The amount under which the FSCS scheme will protect consumers when authorised financial services firms fail.
UK.OBIE.MinimumPaymentDue
The minimum payment required for the current statement period.
UK.OBIE.PendingTransactionsBalance
The total pending transactions balance at the end of the statement period.
UK.OBIE.PreviousClosingBalance
The closing balance of the previous statement.
UK.OBIE.PreviousPayment
The previous payment amount in the last statement period.
UK.OBIE.PurchaseClosingBalance
The component of balance that relates to purchases at the end of the statement period.
UK.OBIE.StartingBalance
The new balance or starting balance carried forward since last statement period.
UK.OBIE.TotalAdjustments
Total adjustments to the account during the statement period.
UK.OBIE.TotalCashAdvances
A 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.TotalCharges
The total charges including interest, late payment fee during the statement period.
UK.OBIE.TotalCredits
Total amount credited in the account during the statement period.
UK.OBIE.TotalDebits
Total amount debited (money taken out from account) from the account during the statement period.
UK.OBIE.TotalPurchases
The total transactions made during that statement period.
OBExternalStatementBenefitType1Code
Code
Description
Code
Description
UK.OBIE.Cashback
Cash back amount received during the statement period.
UK.OBIE.Insurance
Insurance amount during the statement period.
UK.OBIE.TravelDiscount
Trave discound amount received during the statement period.
UK.OBIE.TravelInsurance
Travel insurance amount during the statement period.
OBExternalStatementDateTimeType1Code
Code
Description
Code
Description
UK.OBIE.BalanceTransferPromoEnd
The date the balance transfer promo rate will end.
UK.OBIE.DirectDebitDue
The date that the direct debit payment is due for the current statement.
UK.OBIE.LastPayment
The date than an account holder must make the payment for the previous statement period.
UK.OBIE.LastStatement
The date on which the last statement was made available to account holder.
UK.OBIE.NextStatement
The date on which the next statement will be made available to account holder.
UK.OBIE.PaymentDue
The date than an account holder must make the payment for the current statement period.
UK.OBIE.PurchasePromoEnd
The date the purchase promo rate will end.
UK.OBIE.StatementAvailable
The date on which the current statement was made available to account holder.
OBExternalStatementFeeType1Code
Code
Description
Code
Description
UK.OBIE.Annual
Annual fees charged during the statement period.
UK.OBIE.BalanceTransfer
Balance transfer fees charged during the statement period.
UK.OBIE.CashAdvance
Cash advance fees charged during the statement period.
UK.OBIE.CashTransaction
Cash transaction fees charged during the statement period.
UK.OBIE.ForeignCashTransaction
Foreign cash transaction fees charged during the statement period.
UK.OBIE.ForeignTransaction
Foreign transaction fees charged during the statement period.
UK.OBIE.Gambling
Gambling transaction fees charged during the statement period.
UK.OBIE.LatePayment
Late payment fees charged during the statement period.
UK.OBIE.MoneyTransfer
Money transfer fees charged during the statement period.
UK.OBIE.Monthly
Monthly account fees charged during the statement period.
UK.OBIE.Overlimit
Over limit fees charged during the statement period..
UK.OBIE.PostalOrder
Postal order fees charged during the statement period.
UK.OBIE.PrizeEntry
Prize entry fees charged during the statement period.
UK.OBIE.StatementCopy
Statement copy fees charged during the statement period.
UK.OBIE.Total
Total fees charges during the statement period.
OBExternalStatementInterestType1Code
Code
Description
Code
Description
UK.OBIE.BalanceTransfer
Interest on balance transfers.
UK.OBIE.Cash
Interest on cash advances.
UK.OBIE.EstimatedNext
The estimated interest that will be charged if the closing balance is not paid in full.
UK.OBIE.Purchase
Interest on purchases.
UK.OBIE.Total
Total interest charges during the statement period.
OBExternalStatementRateType1Code
Code
Description
Code
Description
UK.OBIE.AnnualBalanceTransfer
Annual interest rate charged on balance transfer from other service provider.
UK.OBIE.AnnualBalanceTransferAfterPromo
Annual interest rate charged on balance transfer from other service provider after promotional period.
UK.OBIE.AnnualBalanceTransferPromo
Annual interest rate charged on balance transfer from other service provider during promotional period.
UK.OBIE.AnnualCash
Annual interest rate charged on cash advance.
UK.OBIE.AnnualPurchase
Annual interest rate charged on purchases.
UK.OBIE.AnnualPurchaseAfterPromo
Annual interest rate charged on purchases from after promotional period.
UK.OBIE.AnnualPurchasePromo
Annual interest rate charged on purchases from during promotional period.
UK.OBIE.MonthlyBalanceTransfer
Monthly interest rate charged on balance transfer from other service provider.
UK.OBIE.MonthlyCash
Monthly interest rate charged on cash advance.
UK.OBIE.MonthlyPurchase
Monthly interest rate charged on purchases.
OBExternalStatementValueType1Code
Code
Description
Code
Description
UK.OBIE.AirMilesPoints
Air miles points at the end of the statement period.
UK.OBIE.AirMilesPointsBalance
Air miles points at the end of the statement period.
UK.OBIE.Credits
Total number of credits in statement period.
UK.OBIE.Debits
Total number of debits in statement period.
UK.OBIE.HotelPoints
Hotel points at the end of the statement period.
UK.OBIE.HotelPointsBalance
Hotel points at the end of the statement period.
UK.OBIE.RetailShoppingPoints
Retail shopping points at the end of the statement period.
UK.OBIE.RetailShoppingPointsBalance
Retail shopping points at the end of the statement period.
Payment Initiation API Namespaced Enumerations
OBExternalLocalInstrument1Code
This field is used to indicate the ASPSP's payment service to be used for making a payment.
Code
Description
Code
Description
UK.OBIE.BACS
Back Payment Scheme
UK.OBIE.CHAPS
CHAPS Payment Scheme
UK.OBIE.FPS
Faster Payment Scheme
UK.OBIE.SWIFT
Swift Payment Service
UK.OBIE.BalanceTransfer
To indicate Balance Transfer
UK.OBIE.MoneyTransfer
To Indicate Money Transfer
UK.OBIE.Paym
Paym Payment
UK.OBIE.Euro1
To use Euro1 Payment System
UK.OBIE.SEPACreditTransfer
To indicate SEPA Credit Transfer payment service
UK.OBIE.SEPAInstantCreditTransfer
To indicate SEPA Instant Credit Transfer payment service
UK.OBIE.Link
To indicate Link payment service
UK.OBIE.Target2
To indicate Target2 payment service
OBExternalPaymentChargeType1Code
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.
Code
Description
Code
Description
UK.OBIE.CHAPSOut
CHAPS Payment Service fee
UK.OBIE.BalanceTransferOut
Balance Transfer Service fee
UK.OBIE.MoneyTransferOut
Money Transfer Service fee
OBExternalFileType1Code
This field is used to indicate the file-type that is being submitted as part of a file-payment payload.
Code
Description
Code
Description
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.3.1
This is specified when an array of payments, which are compliant with the OBIE Initiation objects in the v3.1 standard, are staged in a .json file for the payment initiation.