NAV Navbar

Product API Reference

Scroll down for code samples, example requests and responses. Code samples are written using CURL for clarity. Scroll down for code samples, example requests and responses.

The Capital One API is designed to allow third party access to our data and services via RESTful endpoints.

It’s part of our roadmap to be a modern technology-based finance provider and part of the open banking movement. Currently one API is available offering the latest information about our products.

During this early phase of API launch we welcome feedback via email.

Whilst in the beta phase we are unable to offer support or guarantee service levels.

Access

URL Description
https://api-dev.capitalone.co.uk/open-banking Production Endpoint; all resources can be accessed via this endpoint.

Consumer Credit Cards

The Consumer Credit Cards resource contains information about Capital One’s latest credit products.

Please note that the API schema is inspired by the Open Banking Commercial Credit Card API in an effort of consistency, however is not part of the official definitions. No SLA or warranty is offered on the operation of this API.

Retrieve credit cards

GET /consumer-credit-cards

Retrieves a complete list of current credit card products including detailed information for each product.

Responses

$ curl -X get "https://api-dev.capitalone.co.uk/open-banking/v1/consumer-credit-cards" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
Parameter Response Type Description
200
OK
Product Response Credit cards are successfully retrieved
400
Bad Request
Error Response The request could not be understood.
404
Not Found
Error Response The requested resource was not found
500
Internal Server Error
Error Response Internal system error has occurred
503
Service Unavailable
Error Response The service is temporarily unavailable

Data Models

Below you can find documentation regarding the data models for the Product API.

Where a data type is not specified (e.g. string or bool), this will refer to a subsequent data model (e.g. ProductDetails or ConsumerCreditCardItem)

ProductResponse

{
    "data": [
        {}
    ],
    "meta": {}
}
Parameter Data Type Description
data
Required
array[Product] Response product data.
meta
Required
Meta Response metadata.

Product

Parameter Data Type Description
Description
Required
string High level product description.
Details
Required
ProductDetails Consumer credit card group.
Eligibility
Required
Eligibility Eligibility criteria
KeyFeatures
Required
string Key features of the product as described on the Capital One website.
Organisation
Required
Organisation Organisation
OtherKeyFeatures string Additional features of the card.
PaymentHoliday
Required
boolean Indicates whether accounts are automatically eligible for payment holidays.
ProductIdentifier
Required
string Identifier within the parent organisation for the product.
ProductName
Required
string Name of the Consumer Credit Card.
ProductSegment array[string] Marketing or industry segments that the product is designed for.
ProductType
Required
string Descriptive code for the product category.
Allowed values: [ConsumerCreditCard]
ProductURL
Required
array[string] URL provided by the organisation which redirects to the product (on live products only). There might be more than one product at a given URL.
TsandCs
Required
array[string] URL provided by the parent organisation which redirects to the current T&Cs. Only applies on live products.

ProductDetails

Parameter Data Type Description
CCSubType
Required
string Credit card subtype.
Allowed values: [FutureMultipleTerms, Promotional, Regular]
ConsumerCreditCardItem
Required
ConsumerCreditCardItem Consumer credit card item.

ConsumerCreditCardItem

Parameter Data Type Description
APRRate
Required
string Annual Percentage Rate. The cost of borrowing on your card expressed as a percentage.
AbilityToSetIndividualLimits boolean The ability to set separate limits on different cards in one account.
AccessToOnlineDataReportingTool
Required
boolean Describes whether the account have access to an online tool for reporting on expenditure.
AnnualFeeAmount
Required
string Account maintenance fee, charged annually.
BalanceTransferRate string Simple annual interest rate charged on balance transfers.
CardScheme
Required
string Card scheme code.
Allowed values: [Cashcard, CreditMastercard, CreditVisa]
CashAdvanceRate
Required
string Simple annual interest rate charged on cash withdrawals.
CashWithdrawalsAllowed
Required
boolean Describes whether cash withdrawals are allowed.
CashbackPercent string Percent of cashback on amount spent.
ConvenienceCheque
Required
boolean Describes whether the card account allow convenience cheques.
DaysInterestFreeCreditIfPaymentFull
Required
integer Describes how many interest free days are given if the card is fully paid at each term. Also known as “Grace days”.
ExchangeRateAdjustment
Required
string The margin added, by certain card issuers, to the scheme rate in order to arrive at the exchange rate quoted as the reference exchange rate to the cardholder.
IssuingEmergencyCardsFees
Required
string Amount payable for issuing an emergency card.
MaximumNumberOfCardsPermitted integer The maximum numbers of cardholders per account.
MinimumCreditLimit
Required
string The minimum credit limit given to successful applications.
MinimumRepaymentAmount string Minimum repayment amount.
MinimumRepaymentPercentage string Percentage of total account balance that will be assessed as a minimum payment in addition to interest and fees.
NonSterlingTransactionFee string A fee applied to all non-Sterling card transactions.
OverLimitFee string Fee applicable if the card balance exceeds the credit limit.
PaymentDaysAfterStatement
Required
integer How many days after statement is the payment expected.
PurchaseRate
Required
string Simple annuals interest rate charged on purchases.
RepaymentFrequency
Required
string Repayment frequency.
Allowed values: [AcademicTerm, HalfYearly, Monthly, Quarterly, Weekly, Yearly]
StatementAtAccountLevel
Required
boolean Describes whether there is a statement at account level.
StatementAtPersonalLevel
Required
boolean Describes whether there is a statement at card level.

Eligibility

Parameter Data Type Description
AgeRestricted
Required
boolean Indicates a customer’s age is part of eligibility criteria.
Description
Required
string Eligibility details as described on the Capital One website.
IncomeRelated boolean Indicates if eligibility linked to income.
MinimumAge integer Minimum age, in years, required to hold an account.
OtherFinancialHoldingRequired
Required
boolean Indicates that it is necessary to hold another product with the bank in order to be eligible for this product or feature.
PreviousBankruptcy
Required
boolean Describes if a previous bankruptcy / insolvency disqualifies for this card.
ResidencyRestricted
Required
boolean Indicates a customer’s residency forms part of the eligibility criteria.

Organisation

Parameter Data Type Description
Brand
Required
Brand Brand
ParentOrganisation
Required
ParentOrganisation Parent organisation.

Brand

Parameter Data Type Description
TrademarkID
Required
string The trademark number that has been registered with the Intellectual Property Office.
TrademarkIPOCode
Required
string The Intellectual Property Office (IPO) is the official body responsible for intellectual property (IP) rights including patents, designs, trademarks and copyright.
Allowed values: [UK, EU]

ParentOrganisation

Parameter Data Type Description
OrganisationName
Required
OrganisationName Organisation name.

OrganisationName

Parameter Data Type Description
LegalName
Required
string Legal Name of the organisation.

Meta

Parameter Data Type Description
Agreement
Required
string Open Banking License agreement.
LastUpdated
Required
string Time at which the product information was last updated.
License
Required
string Open Banking License.
TermsOfUse
Required
string Open Banking Terms of Use.
TotalResults
Required
integer Total number of products returned in the response.

Error Response

{
    "description": "string",
    "status": "string",
    "title": "string"
}
Parameter Data Type Description
description
Required
string Description of the error being reported.
status
Required
string Status code of the error.
title
Required
string Summary of the error being reported.