The Products API from UK Open Banking — 2 operation(s) for products.
openapi: 3.0.0
info:
title: Account and Transaction API Specification Account Access Consents Products API
description: 'Swagger for Account and Transaction API Specification.
**Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
'
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Service Desk
email: ServiceDesk@openbanking.org.uk
license:
name: open-licence
url: https://www.openbanking.org.uk/open-licence
version: 4.0.1
servers:
- url: /open-banking/v4.0/aisp
tags:
- name: Products
paths:
/accounts/{AccountId}/product:
get:
tags:
- Products
summary: Get Product for an AccountId
description: Enables an AISP to retrieve the account product information for a specific PSU account.
operationId: GetAccountsAccountIdProduct
parameters:
- $ref: '#/components/parameters/AccountId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200AccountsAccountIdProductRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
/products:
get:
tags:
- Products
summary: Get Products
description: Enables an AISP to retrieve the account product information for account(s) that the PSU has consented to.
operationId: GetProducts
parameters:
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200ProductsRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
components:
schemas:
OB_FeeFrequency1Code_3:
description: How frequently the fee/charge is calculated
type: string
enum:
- FEAC
- FEAO
- FECP
- FEDA
- FEHO
- FEI
- FEMO
- FEOA
- FEOT
- FEPC
- FEPH
- FEPO
- FEPS
- FEPT
- FEPTA
- FEPTP
- FEQU
- FESM
- FEST
- FEWE
- FEYE
OB_InterestRateType1Code_1:
description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
type: string
enum:
- INBB
- INFR
- INGR
- INLR
- INNE
- INOT
OB_OverdraftFeeType1Code:
description: Overdraft fee type
type: string
enum:
- FBAO
- FBAR
- FBEB
- FBIT
- FBOR
- FBOS
- FBSC
- FBTO
- FBUB
- FBUT
- FTOT
- FTUT
OB_Amount1_0:
description: Cap amount charged for a fee/charge
type: string
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
Meta:
title: MetaData
type: object
description: Meta Data relevant to the payload
properties:
TotalPages:
type: integer
format: int32
FirstAvailableDateTime:
$ref: '#/components/schemas/ISODateTime'
LastAvailableDateTime:
$ref: '#/components/schemas/ISODateTime'
additionalProperties: false
OB_Period1Code:
description: Period e.g. day, week, month etc. for which the fee/charge is capped
type: string
enum:
- PACT
- PDAY
- PHYR
- PMTH
- PQTR
- PWEK
- PYER
OB_Amount1_1:
description: Every additional tranche of an overdraft balance to which an overdraft fee is applied
type: string
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
OB_InterestCalculationMethod1Code:
description: Methods of calculating interest
type: string
enum:
- ITCO
- ITOT
- ITSI
OBError1:
type: object
properties:
ErrorCode:
$ref: '#/components/schemas/OBExternalStatusReason1Code'
Message:
description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''
OBL doesn''t standardise this field'
type: string
minLength: 1
maxLength: 500
Path:
description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
type: string
minLength: 1
maxLength: 500
Url:
description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
type: string
required:
- ErrorCode
additionalProperties: false
minProperties: 1
OB_FeeFrequency1Code_4:
description: Period e.g. day, week, month etc. for which the fee/charge is capped
type: string
enum:
- FEAC
- FEAO
- FECP
- FEDA
- FEHO
- FEI
- FEMO
- FEOA
- FEOT
- FEPC
- FEPH
- FEPO
- FEPS
- FEPT
- FEPTA
- FEPTP
- FEQU
- FESM
- FEST
- FEWE
- FEYE
OBBCAData1:
type: object
title: BCA
properties:
ProductDetails:
type: object
title: ProductDetails
properties:
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.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus on. "
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.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus on. "
type: string
enum:
- ClientAccount
- Standard
- NonCommercialChaitiesClbSoc
- NonCommercialPublicAuthGovt
- Religious
- SectorSpecific
- Startup
- Switcher
FeeFreeLength:
description: The length/duration of the fee free period
title: FeeFreeLength
type: number
format: float
FeeFreeLengthPeriod:
description: The unit of period (days, weeks, months etc.) of the promotional length
title: FeeFreeLengthPeriod
type: string
enum:
- Day
- Half Year
- Month
- Quarter
- Week
- Year
Notes:
description: Optional additional notes to supplement the Core product details
title: Notes
type: array
items:
description: maxLength 2000 text
type: string
minLength: 1
maxLength: 2000
additionalProperties: false
CreditInterest:
description: Details about the interest that may be payable to the BCA 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:-
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'
title: TierBandMethod
type: string
enum:
- Banded
- 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 BCA 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 BCA.
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:
- Daily
- HalfYearly
- Monthly
- Other
- Quarterly
- PerStatementDate
- Weekly
- Yearly
ApplicationFrequency:
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.
title: ApplicationFrequency
type: string
enum:
- Daily
- HalfYearly
- Monthly
- Other
- Quarterly
- PerStatementDate
- Weekly
- Yearly
DepositInterestAppliedCoverage:
description: Amount on which Interest applied.
title: DepositInterestAppliedCoverage
type: string
enum:
- Banded
- 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. \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 BCA.
title: BankInterestRateType
type: string
enum:
- Gross
- Other
BankInterestRate:
description: Bank Interest for the BCA 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
additionalProperties: false
required:
- Name
- Description
OtherApplicationFrequency:
description: Other application frequencies that are not available in the standard code list
type: object
title: OtherApplicationFrequency
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
additionalProperties: false
required:
- Name
- Description
OtherCalculationFrequency:
description: Other calculation frequency which is not available in the standard code set.
type: object
title: OtherCalculationFrequency
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
additionalProperties: false
required:
- Name
- Description
required:
- TierValueMinimum
- ApplicationFrequency
- FixedVariableInterestRateType
- AER
minItems: 1
required:
- TierBandMethod
- Destination
- TierBand
minItems: 1
additionalProperties: false
required:
- TierBandSet
Overdraft:
description: Borrowing details
type: object
title: Overdraft
properties:
Notes:
description: Associated Notes about the overdraft rates
title: Notes
type: array
items:
description: maxLength 2000 text
type: string
minLength: 1
maxLength: 2000
OverdraftTierBandSet:
description: Tier band set details
type: array
title: OverdraftTierBandSet
items:
description: Tier band set details
type: object
properties:
TierBandMethod:
description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation."
title: TierBandMethod
type: string
enum:
- Banded
- Tiered
- Whole
OverdraftType:
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.
title: OverdraftType
type: string
enum:
- Committed
- OnDemand
Identification:
description: Unique and unambiguous identification of a Tier Band for a overdraft product.
title: Identification
type: string
minLength: 1
maxLength: 35
AuthorisedIndicator:
description: Indicates if the Overdraft is authorised (Y) or unauthorised (N)
title: AuthorisedIndicator
type: boolean
BufferAmount:
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.'
title: BufferAmount
type: string
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
Notes:
description: Optional additional notes to supplement the overdraft Tier Band Set details
title: Notes
type: array
items:
description: maxLength 2000 text
type: string
minLength: 1
maxLength: 2000
OverdraftTierBand:
description: Provides overdraft details for a specific tier or band
type: array
title: OverdraftTierBand
items:
description: Provides overdraft details for a specific tier or band
type: object
properties:
Identification:
description: Unique and unambiguous identification of a Tier Band for a overdraft.
title: Identification
type: string
minLength: 1
maxLength: 35
TierValueMin:
description: Minimum value of Overdraft Tier/Band
title: TierValueMin
type: string
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
TierValueMax:
description: Maximum value of Overdraft Tier/Band
title: TierValueMax
type: string
pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$
EAR:
description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently
used interchangeably), being the actual annual interest rate of an Overdraft.'
title: EAR
type: string
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
RepresentativeAPR:
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.
title: RepresentativeAPR
type: string
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
AgreementLengthMin:
description: Specifies the minimum length of a band for a fixed overdraft agreement
title: AgreementLengthMin
type: number
format: float
AgreementLengthMax:
description: Specifies the maximum length of a band for a fixed overdraft agreement
title: AgreementLengthMax
type: number
format: float
AgreementPeriod:
description: Specifies the period of a fixed length overdraft agreement
title: AgreementPeriod
type: string
enum:
- Day
- Half Year
- Month
- Quarter
- Week
- Year
OverdraftInterestChargingCoverage:
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’.
title: OverdraftInterestChargingCoverage
type: string
enum:
- Banded
- Tiered
- Whole
BankGuaranteedIndicator:
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.
title: BankGuaranteedIndicator
type: boolean
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
OverdraftFeesCharges:
description: Overdraft fees and charges
type: array
title: OverdraftFeesCharges
items:
description: Overdraft fees and charges
type: object
properties:
OverdraftFeeChargeCap:
description: 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.
type: array
title: OverdraftFeeChargeCap
items:
description: 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.
type: object
properties:
FeeType:
description: Fee/charge type which is being capped
title: FeeType
type: array
items:
description: Overdraft fee type
type: string
enum:
- ArrangedOverdraft
- AnnualReview
- EmergencyBorrowing
- BorrowingItem
- OverdraftRenewal
- OverdraftSetup
- Surcharge
- TempOverdraft
- UnauthorisedBorrowing
- UnauthorisedPaidTrans
- Other
- UnauthorisedUnpaidTrans
minItems: 1
MinMaxType:
description: Min Max type
title: MinMaxType
type: string
enum:
- Minimum
- Maximum
FeeCapOccurrence:
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.
title: FeeCapOccurrence
type: number
format: float
FeeCapAmount:
descripti
# --- truncated at 32 KB (312 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-banking-uk/refs/heads/main/openapi/open-banking-uk-products-api-openapi.yml