PUBLIC, unauthenticated OBIE Open Data Personal Current Accounts (PCA) API — reference product data (features, fees, rates, eligibility) for personal current accounts. Conforms to the OBIE Open Data API Standard v2.4. Documented/standard for this ASPSP; the live endpoint was not verified.
{
"swagger": "2.0",
"info": {
"version": "v2.4",
"title": "Open Data API",
"description": "Latest Swagger specification for OpenData Personal Current Account data"
},
"host": "developer.openbanking.org.uk",
"basePath": "/open-banking/v2.4",
"schemes": [
"https"
],
"produces": [
"application/prs.openbanking.opendata.v2.4+json"
],
"tags": [
{
"name": "PCA",
"description": "Endpoint for getting Personal Current Account data"
}
],
"paths": {
"/personal-current-accounts": {
"get": {
"tags": [
"PCA"
],
"description": "Gets a list of all `Personal Current Account` objects.",
"parameters": [
{
"name": "If-Modified-Since",
"type": "string",
"description": "Used for conditional request, to retrieve data only if modified since a given date",
"in": "header",
"required": false
},
{
"name": "If-None-Match",
"type": "string",
"description": "Used for conditional request, to retrieve data only if the given Etag value does not match",
"in": "header",
"required": false
}
],
"responses": {
"200": {
"description": "Successful response with a list of `Personal Current Account` data",
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header",
"default": "max-age=31536000"
},
"Etag": {
"type": "string",
"description": "A unique ID identifying whether this resource has changed"
},
"Cache-Control": {
"type": "string",
"description": "Describes how long this response can be cached",
"default": "max-age=28800"
},
"X-Frame-Options": {
"type": "string",
"description": "Prevent this request from being loaded in any iframes",
"default": "DENY"
},
"X-Content-Type-Options": {
"type": "string",
"description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing",
"default": "nosniff"
}
},
"schema": {
"type": "object",
"properties": {
"meta": {
"title": "Meta data",
"type": "object",
"properties": {
"LastUpdated": {
"type": "string",
"format": "date-time"
},
"TotalResults": {
"type": "integer"
},
"Agreement": {
"type": "string",
"enum": [
"Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms and conditions"
]
},
"License": {
"description": "Open Banking License",
"type": "string",
"format": "uri",
"enum": [
"https://www.openbanking.org.uk/open-licence"
]
},
"TermsOfUse": {
"description": "Open Banking Terms of Use",
"type": "string",
"format": "uri",
"enum": [
"https://www.openbanking.org.uk/terms"
]
}
},
"required": [
"LastUpdated",
"TotalResults",
"Agreement",
"License",
"TermsOfUse"
],
"additionalProperties": false
},
"data": {
"type": "array",
"items": {
"properties": {
"Brand": {
"description": "Brand registered by the banking group at https://register.fca.org.uk/",
"type": "array",
"title": "Brand",
"items": {
"description": "Brand registered by the banking group at https://register.fca.org.uk/",
"type": "object",
"properties": {
"BrandName": {
"description": "Brand Name that an organisation uses to market its products or services to a consumer as registered at https://register.fca.org.uk/",
"title": "BrandName",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"PCA": {
"description": "PCA' means a personal current account. That is an account marketed to individuals rather than businesses, which provides the facility to place funds, withdraw cash, hold deposits and to execute payment transaction to and from third parties but does not include any of the following types of accounts: \n(a) an account in which money is held on deposit in a currency other than sterling; (b) current account mortgage, ie a single account comprising both a personal current account and a mortgage, which is regulated and marketed principally as a mortgage; \n(c) savings accounts (including instant access savings accounts); \n(d) credit card accounts where funds are usually paid in for the sole purpose of repaying a credit card debt; and \n(e) e-money accounts.",
"type": "array",
"title": "PCA",
"items": {
"description": "PCA' means a personal current account. That is an account marketed to individuals rather than businesses, which provides the facility to place funds, withdraw cash, hold deposits and to execute payment transaction to and from third parties but does not include any of the following types of accounts: \n(a) an account in which money is held on deposit in a currency other than sterling; (b) current account mortgage, ie a single account comprising both a personal current account and a mortgage, which is regulated and marketed principally as a mortgage; \n(c) savings accounts (including instant access savings accounts); \n(d) credit card accounts where funds are usually paid in for the sole purpose of repaying a credit card debt; and \n(e) e-money accounts.",
"type": "object",
"properties": {
"Name": {
"description": "The name of the PCA product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Identification": {
"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.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Segment": {
"description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nFollow us: Investopedia on Facebook\n\nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus on. For example, Basic PCA products target consumers with poor credit history, Reward PCA products target consumers who spend a lot, and Premium products target High Net Worth individuals.",
"title": "Segment",
"type": "array",
"items": {
"description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nFollow us: Investopedia on Facebook\n\nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus on. For example, Basic PCA products target consumers with poor credit history, Reward PCA products target consumers who spend a lot, and Premium products target High Net Worth individuals.",
"type": "string",
"enum": [
"Basic",
"BenefitAndReward",
"CreditInterest",
"Cashback",
"General",
"Graduate",
"Other",
"Overdraft",
"Packaged",
"Premium",
"Reward",
"Student",
"YoungAdult",
"Youth"
]
}
},
"OnSaleIndicator": {
"description": "Indicates that the published product is OnSale(value 1) or Back Book (value 0)",
"title": "OnSaleIndicator",
"type": "boolean"
},
"Notes": {
"description": "Optional additional notes to supplement the product details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"PCAMarketingState": {
"description": "Describes the type of the known state (regular, promotional ) of the product.",
"type": "array",
"title": "PCAMarketingState",
"items": {
"description": "Describes the type of the known state (regular, promotional ) of the product.",
"type": "object",
"properties": {
"Identification": {
"description": "Unique and unambiguous identification of a Eligibility Marketing state.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"PredecessorID": {
"description": "Identifies the marketing state that precedes this marketing state",
"title": "PredecessorID",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"MarketingState": {
"description": "Describes the marketing state (regular or promotional) for which the eligibility criteria applies",
"title": "MarketingState",
"type": "string",
"enum": [
"Promotional",
"Regular"
]
},
"FirstMarketedDate": {
"description": "Marketing state start date",
"title": "FirstMarketedDate",
"type": "string",
"format": "date"
},
"LastMarketedDate": {
"description": "Marketing state end date",
"title": "LastMarketedDate",
"type": "string",
"format": "date"
},
"StateTenureLength": {
"description": "The length/duration of a promotional state",
"title": "StateTenureLength",
"type": "number",
"format": "float"
},
"StateTenurePeriod": {
"description": "The unit of period (days, weeks, months etc.) of the promotional length",
"title": "StateTenurePeriod",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"AcademicTerm",
"Year"
]
},
"Notes": {
"description": "Free text for adding details for marketing state",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"CreditInterest": {
"description": "Details about the interest that may be payable to the PCA account holders",
"type": "object",
"title": "CreditInterest",
"properties": {
"TierBandSet": {
"description": "The group of tiers or bands for which credit interest can be applied.",
"type": "array",
"title": "TierBandSet",
"items": {
"description": "The group of tiers or bands for which credit interest can be applied.",
"type": "object",
"properties": {
"TierBandMethod": {
"description": "The methodology of how credit interest is paid/applied. It can be:-\n\n1. Banded\nInterest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n\n2. Tiered\nInterest 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.\n\n3. Whole\nThe same interest rate is applied irrespective of the PCA balance",
"title": "TierBandMethod",
"type": "string",
"enum": [
"Tiered",
"Whole"
]
},
"CalculationMethod": {
"description": "Methods of calculating interest",
"title": "CalculationMethod",
"type": "string",
"enum": [
"Compound",
"SimpleInterest"
]
},
"Destination": {
"description": "Describes whether accrued interest is payable only to the PCA or to another bank account",
"title": "Destination",
"type": "string",
"enum": [
"PayAway",
"SelfCredit"
]
},
"Notes": {
"description": "Optional additional notes to supplement the Tier Band Set details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"TierBand": {
"description": "Tier Band Details",
"type": "array",
"title": "TierBand",
"items": {
"description": "Tier Band Details",
"type": "object",
"properties": {
"Identification": {
"description": "Unique and unambiguous identification of a Tier Band for a PCA.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"TierValueMinimum": {
"description": "Minimum deposit value for which the credit interest tier applies.",
"title": "TierValueMinimum",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"TierValueMaximum": {
"description": "Maximum deposit value for which the credit interest tier applies.",
"title": "TierValueMaximum",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"CalculationFrequency": {
"description": "How often is credit interest calculated for the account.",
"title": "CalculationFrequency",
"type": "string",
"enum": [
"PerAcademicTerm",
"Daily",
"HalfYearly",
"Monthly",
"Other",
"Quarterly",
"PerStatementDate",
"Weekly",
"Yearly"
]
},
"ApplicationFrequency": {
"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.",
"title": "ApplicationFrequency",
"type": "string",
"enum": [
"PerAcademicTerm",
"Daily",
"HalfYearly",
"Monthly",
"Other",
"Quarterly",
"PerStatementDate",
"Weekly",
"Yearly"
]
},
"DepositInterestAppliedCoverage": {
"description": "Amount on which Interest applied.",
"title": "DepositInterestAppliedCoverage",
"type": "string",
"enum": [
"Tiered",
"Whole"
]
},
"FixedVariableInterestRateType": {
"description": "Type of interest rate, Fixed or Variable",
"title": "FixedVariableInterestRateType",
"type": "string",
"enum": [
"Fixed",
"Variable"
]
},
"AER": {
"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. \n\nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A",
"title": "AER",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
},
"BankInterestRateType": {
"description": "Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA.",
"title": "BankInterestRateType",
"type": "string",
"enum": [
"LinkedBaseRate",
"Gross",
"Net",
"Other"
]
},
"BankInterestRate": {
"description": "Bank Interest for the PCA product",
"title": "BankInterestRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
},
"Notes": {
"description": "Optional additional notes to supplement the Tier Band details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherBankInterestType": {
"description": "Other interest rate types which are not available in the standard code list",
"type": "object",
"title": "OtherBankInterestType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used within an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "^\\w{0,4}$",
"minLength": 0,
"maxLength": 4
},
"Name": {
"description": "Long name associated with the code",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"Description": {
"description": "Description to describe the purpose of the code",
"title": "Description",
"type": "string",
"minLength": 1,
"maxLength": 350
# --- truncated at 32 KB (333 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/weatherbys-bank/refs/heads/main/openapi/obie-opendata-personal-current-accounts-standard.json