production
development
https://api.lloydsbank.com
Custom API Endpoint
Paths
/branches
get /branches
Branch
Gets a list of all Branch objects.
If-Modified-Since
Optional in header
string
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
Optional in header
string
Used for conditional request, to retrieve data only if the given Etag value does not match
Accept
Optional in header
string
application/prs.openbanking.opendata.v2.1+json
200
Successful response with a list of Branch 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",
{
"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 owned by an organisation",
"type": "array",
"title": "Brand",
"items": {
"description": "Brand owned by an organisation",
"type": "object",
"properties": {
"BrandName": {
"description": "Brand Name that an organisation uses to market its products or services to a consumer",
"title": "BrandName",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Branch": {
"description": "Information that locates and identifies a specific branch of a financial institution.",
"type": "array",
"title": "Branch",
"items": {
"description": "Information that locates and identifies a specific branch of a financial institution.",
"type": "object",
"properties": {
"Identification": {
"description": "Unique and unambiguous identification of a branch of a financial institution.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"SequenceNumber": {
"description": "Sequence Number that is used in conjunction with Identification to uniquely identify a branch. Physical branches should have 0 assigned, mobile and sub branches should have 1,2,3....etc. assigned.",
"title": "SequenceNumber",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"description": "Name by which a branch is known and which is usually used to identify that branch.",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Type": {
"description": "Codeset to indicate if a branch is physically in 1 location or is mobile",
"title": "Type",
"type": "string",
"enum": [
"Mobile",
"Physical"
]
},
"Photo": {
"description": "Image related to the branch",
"title": "Photo",
"type": "string"
},
"CustomerSegment": {
"description": "The marketing segment which the branch is able to address in terms of customer type. 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",
"title": "CustomerSegment",
"type": "array",
"items": {
"description": "The marketing segment which the branch is able to address in terms of customer type. 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",
"type": "string",
"enum": [
"Business",
"Corporate",
"Other",
"Personal",
"Private",
"Premier",
"Select",
"SME",
"Wealth"
]
},
"minItems": 1
},
"ServiceAndFacility": {
"description": "Service\/Facilities offered at a branch.",
"title": "ServiceAndFacility",
"type": "array",
"items": {
"description": "Service\/Facilities offered at a branch.",
"type": "string",
"enum": [
"AssistedServiceCounter",
"ExternalATM",
"AccountVerificationService",
"BusinessCounter",
"BureauDeChange",
"BusinessDepositTerminal",
"BusinessITSupport",
"CardIssuanceFacility",
"CollectionLockers",
"CounterServices",
"ExternalQuickServicePoint",
"InternalQuickServicePoint",
"InternalATM",
"LodgementDevice",
"MortgageAdvisor",
"MeetingRooms",
"NightSafe",
"OnlineBankingPoint",
"OnDemandCurrency",
"Other",
"Parking",
"PremierCounter",
"QuickDeposit",
"SaturdayCounterService",
"StatementPrinter",
"SelfServiceAccountOpening",
"VideoBanking",
"WiFi"
]
}
},
"Accessibility": {
"description": "Accessibility is the ability and ease a customer can access a service, good, associate, or facility. Features which make the Bank accessible to disabled people",
"title": "Accessibility",
"type": "array",
"items": {
"description": "Accessibility is the ability and ease a customer can access a service, good, associate, or facility. Features which make the Bank accessible to disabled people",
"type": "string",
"enum": [
"AutomaticDoors",
"AudioCashMachine",
"ExternalRamp",
"HelpingHandUnit",
"InductionLoop",
"InternalRamp",
"LevelAccess",
"LowerLevelCounter",
"Other",
"WheelchairAccess"
]
}
},
"Note": {
"description": "Summary description of services, facility and availability.",
"title": "Note",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"OtherCustomerSegment": {
"description": "Enter a new code , name and description for any other Customer Segment",
"type": "array",
"title": "OtherCustomerSegment",
"items": {
"description": "Enter a new code , name and description for any other Customer Segment",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used within an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"OtherAccessibility": {
"description": "Enter any new code , name and description for any other Accessibility",
"type": "array",
"title": "OtherAccessibility",
"items": {
"description": "Enter any new code , name and description for any other Accessibility",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used within an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"OtherServiceAndFacility": {
"description": "Enter any new code , name and description for any Other Facility",
"type": "array",
"title": "OtherServiceAndFacility",
"items": {
"description": "Enter any new code , name and description for any Other Facility",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used within an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"Availability": {
"description": "Days and times defining when the branch is available for use by a customer",
"type": "object",
"title": "Availability",
"properties": {
"StandardAvailability": {
"description": "Standard hours of availability for the branch of the organisation",
"type": "object",
"title": "StandardAvailability",
"properties": {
"Day": {
"description": "Working day information",
"type": "array",
"title": "Day",
"items": {
"description": "Working day information",
"type": "object",
"properties": {
"Name": {
"description": "Specifies the day of the week",
"title": "Name",
"type": "string",
"enum": [
"Friday",
"Monday",
"Saturday",
"Sunday",
"Thursday",
"Tuesday",
"Wednesday"
]
},
"Notes": {
"description": "Specify any note that is related the particular opening day e.g. Closed half day on Monday",
"title": "Notes",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"OpeningHours": {
"description": "Opening & Closing Times of a branch of an organisation",
"type": "array",
"title": "OpeningHours",
"items": {
"description": "Opening & Closing Times of a branch of an organisation",
"type": "object",
"properties": {
"OpeningTime": {
"description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+\/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning \/ end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.",
"title": "OpeningTime",
"type": "string",
"pattern": "^(([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.\\d{3}){0,1})|(^(24:00:00)(\\.000){0,1})(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$"
},
"ClosingTime": {
"description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+\/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning \/ end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.",
"title": "ClosingTime",
"type": "string",
"pattern": "^(([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.\\d{3}){0,1})|(^(24:00:00)(\\.000){0,1})(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$"
}
},
"additionalProperties": false,
"minItems": 1,
"required": [
"OpeningTime",
"ClosingTime"
]
}
}
},
"additionalProperties": false,
"minItems": 1,
"maxItems": 7,
"required": [
"Name",
"OpeningHours"
]
}
}
},
"additionalProperties": false,
"required": [
"Day"
]
},
"NonStandardAvailability": {
"description": "Non-standard hours of availability for a branch of an organisation",
"type": "object",
"title": "NonStandardAvailability",
"properties": {
"Name": {
"description": "Name provided for non-standard opening periods e.g. Christmas",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"StartDate": {
"description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.",
"title": "StartDate",
"type": "string",
"format": "date"
},
"EndDate": {
"description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.",
"title": "EndDate",
"type": "string",
"format": "date"
},
"Notes": {
"description": "Notes related to the Non-standard hours e.g. During shrimp season, the branch has extended opening hours",
"title": "Notes",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"Day": {
"description": "Working day information",
"type": "array",
"title": "Day",
"items": {
"description": "Working day information",
"type": "object",
"properties": {
"Name": {
"description": "Specifies the day of the week",
"title": "Name",
"type": "string",
"enum": [
"Friday",
"Monday",
"Saturday",
"Sunday",
"Thursday",
"Tuesday",
"Wednesday"
]
},
"Notes": {
"description": "Specify any note that is related the particular opening day e.g. Closed half day on Monday",
"title": "Notes",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"OpeningHours": {
"description": "Opening & Closing Times of a branch of an organisation",
"type": "array",
"title": "OpeningHours",
"items": {
"description": "Opening & Closing Times of a branch of an organisation",
"type": "object",
"properties": {
"OpeningTime": {
"description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+\/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning \/ end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.",
"title": "OpeningTime",
"type": "string",
"pattern": "^(([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.\\d{3}){0,1})|(^(24:00:00)(\\.000){0,1})(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$"
},
"ClosingTime": {
"description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+\/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning \/ end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.",
"title": "ClosingTime",
"type": "string",
"pattern": "^(([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.\\d{3}){0,1})|(^(24:00:00)(\\.000){0,1})(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$"
}
},
"additionalProperties": false,
"minItems": 1,
"required": [
"OpeningTime",
"ClosingTime"
]
}
}
},
"additionalProperties": false,
"minItems": 0,
"maxItems": 7,
"required": [
"Name",
"OpeningHours"
]
}
}
},
"additionalProperties": false,
"required": [
"Name"
]
}
},
"additionalProperties": false,
"required": [
"StandardAvailability"
]
},
"ContactInfo": {
"description": "Communication device number or electronic address used for communication.",
"type": "array",
"title": "ContactInfo",
"items": {
"description": "Communication device number or electronic address used for communication.",
"type": "object",
"properties": {
"ContactType": {
"description": "Contact type such Phone, Fax and email",
"title": "ContactType",
"type": "string",
"enum": [
"AlternateEmail",
"AlternateFax",
"AlternatePhone",
"Email",
"Fax",
"Other",
"Phone"
]
},
"ContactContent": {
"description": "Collection of information that identifies a phone\/Fax number\/ email, as defined by telecom services.",
"type": "object",
"title": "ContactContent",
"properties": [],
"additionalProperties": false
},
"ContactDescription": {
"description": "Description of contact such as main phone number, alternate phone number, Fax number, alternate fax number, email and alternate email",
"title": "ContactDescription",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"OtherContactType": {
"description": "Other contact type which is not in the standard code list",
"type": "object",
"title": "OtherContactType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"additionalProperties": false,
"required": [
"ContactType",
"ContactContent"
]
}
},
"PostalAddress": {
"description": "Information that locates and identifies a specific address, as defined by postal services.",
"type": "object",
"title": "PostalAddress",
"properties": {
"AddressLine": {
"description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.",
"title": "AddressLine",
"type": "array",
"items": {
"description": "maxLength 70 text",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minItems": 0,
"maxItems": 7
},
"BuildingNumber": {
"description": "Name or Number that identifies the position of a building on a street.",
"title": "BuildingNumber",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"StreetName": {
"description": "Name of a street or thoroughfare.",
"title": "StreetName",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"TownName": {
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"title": "TownName",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country, for instance state, region, county.",
"title": "CountrySubDivision",
"type": "array",
"items": {
"description": "maxLength 35 text",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"minItems": 0,
"maxItems": 2
},
"Country": {
"description": "Nation with its own government, occupying a particular territory.",
"title": "Country",
"type": "string",
"pattern": "[A-Z]{2}"
},
"PostCode": {
"description": "Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.",
"title": "PostCode",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"GeoLocation": {
"description": "Geographic location of the ATM specified by geographic coordinates or UTM coordinates.",
"type": "object",
"title": "GeoLocation",
"properties": {
"GeographicCoordinates": {
"description": "Location on the earth specified by two numbers representing vertical and horizontal position.",
"type": "object",
"title": "GeographicCoordinates",
"properties": {
"Latitude": {
"description": "Latitude measured in decimal degrees",
"title": "Latitude",
"type": "string",
"pattern": "^-?\\d{1,3}\\.\\d{1,8}$"
},
"Longitude": {
"description": "Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.\nThe longitude is measured in decimal degrees.",
"title": "Longitude",
"type": "string",
"pattern": "^-?\\d{1,3}\\.\\d{1,8}$"
}
},
"additionalProperties": false,
"required": [
"Latitude",
"Longitude"
]
}
},
"additionalProperties": false,
"required": [
"GeographicCoordinates"
]
}
},
"additionalProperties": false,
"required": [
"PostCode"
]
}
},
"additionalProperties": false,
"minItems": 1,
"required": [
"Identification",
"SequenceNumber",
"Type",
"CustomerSegment",
"PostalAddress"
]
}
}
},
"additionalProperties": false,
"minItems": 1,
"required": [
"BrandName",
"Branch"
]
}
}
},
"required": [
"Brand"
],
"description": "Environment of the branch",
"type": "object"
}
}
},
"required": [
"meta",
"data"
],
"additionalProperties": false
}
}
x
400
You have sent a request which could not be understood.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "400 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"400"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "400 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"400"
]
},
"title": {
"type": "string",
"enum": [
"Bad request"
]
},
"description": {
"type": "string",
"enum": [
"You have sent a request which could not be understood."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
408
Your client has failed to submit a request, and a timeout has occurred.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "408 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"408"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "408 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"408"
]
},
"title": {
"type": "string",
"enum": [
"Client timeout"
]
},
"description": {
"type": "string",
"enum": [
"Your client has failed to submit a request, and a timeout has occurred."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
429
You have requested this resource too often. Slow down.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "429 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"429"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "429 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"429"
]
},
"title": {
"type": "string",
"enum": [
"Too many requests"
]
},
"description": {
"type": "string",
"enum": [
"You have requested this resource too often. Slow down."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
500
An error occurred on the server. No further information is available.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "500 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"500"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "500 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"500"
]
},
"title": {
"type": "string",
"enum": [
"Internal server error"
]
},
"description": {
"type": "string",
"enum": [
"An error occurred on the server. No further information is available."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
503
The service is temporarily unavailable.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "503 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"503"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "503 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"503"
]
},
"title": {
"type": "string",
"enum": [
"Service temporarily unavailable"
]
},
"description": {
"type": "string",
"enum": [
"The service is temporarily unavailable."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
default
A standard error response.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "Error object",
"type": "object",
"properties": {
"status": {
"description": "This corresponds to the HTTP status code",
"type": "string"
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "Error object",
"type": "object",
"properties": {
"status": {
"description": "This corresponds to the HTTP status code",
"type": "string"
},
"title": {
"description": "A short title of the type of error",
"type": "string"
},
"description": {
"description": "Further details describing the error",
"type": "string"
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
Example Request
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
head /branches
Branch
Gets header information on the current set of Branch data
If-Modified-Since
Optional in header
string
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
Optional in header
string
Used for conditional request, to retrieve data only if the given Etag value does not match
Accept
Optional in header
string
application/prs.openbanking.opendata.v2.1+json
default
No response
{
"schema": {
"title": "No response",
"type": "object",
"properties": []
}
}Example Request
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
/atms
get /atms
ATM
Gets a list of all ATM objects.
If-Modified-Since
Optional in header
string
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
Optional in header
string
Used for conditional request, to retrieve data only if the given Etag value does not match
Accept
Optional in header
string
application/prs.openbanking.opendata.v2.1+json
200
Successful response with a list of ATM 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": {
"title": "ATM",
{
"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": {
"title": "ATM",
"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 of the Acquirer of transactions captured by the ATM",
"type": "array",
"title": "Brand",
"items": {
"description": "Brand of the Acquirer of transactions captured by the ATM",
"type": "object",
"properties": {
"BrandName": {
"description": "Brand Name that an organisation uses to market its products or services to a consumer",
"title": "BrandName",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"ATM": {
"description": "ATM information.",
"type": "array",
"title": "ATM",
"items": {
"description": "ATM information.",
"type": "object",
"properties": {
"Identification": {
"description": "ATM terminal device identification for the acquirer and the issuer.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"SupportedLanguages": {
"description": "Identification of the language name according to the ISO 639-1 codes. The type is validated by the list of values coded with two alphabetic characters, defined in the standard.",
"title": "SupportedLanguages",
"type": "array",
"items": {
"description": "Identification of the language name according to the ISO 639-1 codes. The type is validated by the list of values coded with two alphabetic characters, defined in the standard.",
"type": "string",
"pattern": "[a-z]{2}"
}
},
"ATMServices": {
"description": "Describes the type of transaction available for a customer on an ATM.",
"title": "ATMServices",
"type": "array",
"items": {
"description": "Describes the type of transaction available for a customer on an ATM.",
"type": "string",
"enum": [
"Balance",
"BillPayments",
"CashDeposits",
"CharityDonation",
"ChequeDeposits",
"CashWithdrawal",
"EnvelopeDeposit",
"FastCash",
"MobileBankingRegistration",
"MobilePaymentRegistration",
"MobilePhoneTopUp",
"OrderStatement",
"Other",
"PINActivation",
"PINChange",
"PINUnblock",
"MiniStatement"
]
}
},
"Accessibility": {
"description": "Indicates Types of Accessibility",
"title": "Accessibility",
"type": "array",
"items": {
"description": "Indicates Types of Accessibility",
"type": "string",
"enum": [
"AudioCashMachine",
"AutomaticDoors",
"ExternalRamp",
"InductionLoop",
"InternalRamp",
"LevelAccess",
"LowerLevelCounter",
"Other",
"WheelchairAccess"
]
}
},
"Access24HoursIndicator": {
"description": "Indicates that the ATM is available for use by customers 24 hours per day",
"title": "Access24HoursIndicator",
"type": "boolean"
},
"SupportedCurrencies": {
"description": "All ISO 4217 defined currency supported by the ATM.",
"title": "SupportedCurrencies",
"type": "array",
"items": {
"description": "ISO 4217 defined currency",
"type": "string",
"pattern": "[A-Z]{3}"
},
"minItems": 1
},
"MinimumPossibleAmount": {
"description": "Minimum amount allowed for a transaction in the service.",
"title": "MinimumPossibleAmount",
"type": "string",
"pattern": "[0-9]{0,13}(\\.?[0-9]{0,5})?"
},
"Note": {
"description": "Summary description of the ATM.",
"title": "Note",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"OtherAccessibility": {
"description": "Enter a new code , name and description for any other ATM accessibility options",
"type": "array",
"title": "OtherAccessibility",
"items": {
"description": "Enter a new code , name and description for any other ATM accessibility options",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"OtherATMServices": {
"description": "Enter a new code , name and description for any other ATM Service",
"type": "array",
"title": "OtherATMServices",
"items": {
"description": "Enter a new code , name and description for any other ATM Service",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"Branch": {
"description": "Information that locates and identifies a specific branch of a financial institution.",
"type": "object",
"title": "Branch",
"properties": {
"Identification": {
"description": "Unique and unambiguous identification of a branch of a financial institution.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
}
},
"additionalProperties": false
},
"Location": {
"description": "Location of the ATM.",
"type": "object",
"title": "Location",
"properties": {
"LocationCategory": {
"description": "Indicates the environment of the ATM.",
"title": "LocationCategory",
"type": "array",
"items": {
"description": "Indicates the environment of the ATM.",
"type": "string",
"enum": [
"BranchExternal",
"BranchInternal",
"BranchLobby",
"Other",
"RetailerOutlet",
"RemoteUnit"
]
}
},
"OtherLocationCategory": {
"description": "Enter a new code , name and description for any other location category",
"type": "array",
"title": "OtherLocationCategory",
"items": {
"description": "Enter a new code , name and description for any other location category",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin an XML file to identify a code",
"title": "Code",
"type": "string",
"pattern": "[A-Z]{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"
]
}
},
"Site": {
"description": "Used by a Financial Institution internally to identify the location of an ATM.",
"type": "object",
"title": "Site",
"properties": {
"Identification": {
"description": "ATM site identification for the Financial Institution.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Name": {
"description": "ATM site name as used by Financial Institution.",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 140
}
},
"additionalProperties": false
},
"PostalAddress": {
"description": "Information that locates and identifies a specific address, as defined by postal services or in free format text.",
"type": "object",
"title": "PostalAddress",
"properties": {
"AddressLine": {
"description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.",
"title": "AddressLine",
"type": "array",
"items": {
"description": "maxLength 70 text",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"minItems": 0,
"maxItems": 7
},
"BuildingNumber": {
"description": "Name or Number that identifies the position of a building on a street.",
"title": "BuildingNumber",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"StreetName": {
"description": "Name of a street or thoroughfare.",
"title": "StreetName",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"TownName": {
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"title": "TownName",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country, for instance state, region, county.",
"title": "CountrySubDivision",
"type": "array",
"items": {
"description": "maxLength 35 text",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"minItems": 0,
"maxItems": 2
},
"Country": {
"description": "Nation with its own government, occupying a particular territory.",
"title": "Country",
"type": "string",
"pattern": "[A-Z]{2}"
},
"PostCode": {
"description": "Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.",
"title": "PostCode",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"GeoLocation": {
"description": "Geographic location of the ATM specified by geographic coordinates or UTM coordinates.",
"type": "object",
"title": "GeoLocation",
"properties": {
"GeographicCoordinates": {
"description": "Location on the earth specified by two numbers representing vertical and horizontal position.",
"type": "object",
"title": "GeographicCoordinates",
"properties": {
"Latitude": {
"description": "Latitude measured in decimal degrees.",
"title": "Latitude",
"type": "string",
"pattern": "^-?\\d{1,3}\\.\\d{1,8}$"
},
"Longitude": {
"description": "Angular measurement of the distance of a location on the earth east or west of the Greenwich observatory.\nThe longitude is measured in decimal degrees.",
"title": "Longitude",
"type": "string",
"pattern": "^-?\\d{1,3}\\.\\d{1,8}$"
}
},
"additionalProperties": false,
"required": [
"Latitude",
"Longitude"
]
}
},
"additionalProperties": false,
"required": [
"GeographicCoordinates"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"PostalAddress"
]
}
},
"additionalProperties": false,
"minItems": 1,
"required": [
"Identification",
"SupportedCurrencies",
"Location"
]
}
}
},
"additionalProperties": false,
"minItems": 1,
"required": [
"BrandName",
"ATM"
]
}
}
},
"required": [
"Brand"
],
"description": "Environment of the ATM.",
"type": "object"
}
}
},
"required": [
"meta",
"data"
],
"additionalProperties": false
}
}
x
400
You have sent a request which could not be understood.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "400 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"400"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "400 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"400"
]
},
"title": {
"type": "string",
"enum": [
"Bad request"
]
},
"description": {
"type": "string",
"enum": [
"You have sent a request which could not be understood."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
408
Your client has failed to submit a request, and a timeout has occurred.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "408 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"408"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "408 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"408"
]
},
"title": {
"type": "string",
"enum": [
"Client timeout"
]
},
"description": {
"type": "string",
"enum": [
"Your client has failed to submit a request, and a timeout has occurred."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
429
You have requested this resource too often. Slow down.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "429 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"429"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "429 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"429"
]
},
"title": {
"type": "string",
"enum": [
"Too many requests"
]
},
"description": {
"type": "string",
"enum": [
"You have requested this resource too often. Slow down."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
500
An error occurred on the server. No further information is available.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "500 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"500"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "500 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"500"
]
},
"title": {
"type": "string",
"enum": [
"Internal server error"
]
},
"description": {
"type": "string",
"enum": [
"An error occurred on the server. No further information is available."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
503
The service is temporarily unavailable.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "503 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"503"
]
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "503 Error object",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"503"
]
},
"title": {
"type": "string",
"enum": [
"Service temporarily unavailable"
]
},
"description": {
"type": "string",
"enum": [
"The service is temporarily unavailable."
]
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
default
A standard error response.
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "Error object",
"type": "object",
"properties": {
"status": {
"description": "This corresponds to the HTTP status code",
"type": "string"
},
{
"headers": {
"Strict-Transport-Security": {
"type": "string",
"description": "HTTPS strict transport security header"
},
"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"
},
"Status Code": {
"type": "integer",
"description": "The HTTP status code defining the error",
"default": 400
}
},
"schema": {
"title": "Error object",
"type": "object",
"properties": {
"status": {
"description": "This corresponds to the HTTP status code",
"type": "string"
},
"title": {
"description": "A short title of the type of error",
"type": "string"
},
"description": {
"description": "Further details describing the error",
"type": "string"
}
},
"required": [
"status",
"title",
"description"
],
"additionalProperties": false
}
}
x
Example Request
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
head /atms
ATM
Gets header information on the current set of ATM data
If-Modified-Since
Optional in header
string
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
Optional in header
string
Used for conditional request, to retrieve data only if the given Etag value does not match
Accept
Optional in header
string
application/prs.openbanking.opendata.v2.1+json
default
No response
{
"schema": {
"title": "No response",
"type": "object",
"properties": []
}
}Example Request
Try this operation
No response. This is a mixed content call. It is not possible to test HTTP APIs from an HTTPS secured Portal site and vice versa.
No response. This is a cross-origin call. Make sure the server accepts requests from this portal. Or if using self-signed SSL certificates then paste the URL above into your browser to accept the certificate before trying again (On Internet Explorer it must be the same browser tab.).
/personal-current-accounts
get /personal-current-accounts
PCA
Gets a list of all Personal Current Account objects.
If-Modified-Since
Optional in header
string
Used for conditional request, to retrieve data only if modified since a given date
If-None-Match
Optional in header
string
Used for conditional request, to retrieve data only if the given Etag value does not match
Accept
Optional in header
string
application/prs.openbanking.opendata.v2.1+json
200
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",
{
"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: (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; (c) savings accounts (including instant access savings accounts); (d) credit card accounts where funds are usually paid in for the sole purpose of repaying a credit card debt; and (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: (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; (c) savings accounts (including instant access savings accounts); (d) credit card accounts where funds are usually paid in for the sole purpose of repaying a credit card debt; and (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": 35
},
"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 Follow us: Investopedia on Facebook\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.\nRead more: Market Segmentation http:\/\/www.investopedia.com\/terms\/m\/marketsegmentation.asp#ixzz4gfEEalTd Follow us: Investopedia on Facebook\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",
"General",
"Graduate",
"Packaged",
"Premium",
"Reward",
"Student",
"YoungAdult",
"Youth"
]
},
"minItems": 1
},
"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",
"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 charged. It can be:-\n1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n2. 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.\n3. Whole The 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.\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 payble to the PCA.",
"title": "BankInterestRateType",
"type": "string",
"enum": [
"LinkedBaseRate",
"Gross",
"Net",
"Other"
]
},
"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 whithin 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 whithin 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 whithin 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": [
"Identification",
"TierValueMinimum",
"CalculationFrequency",
"ApplicationFrequency",
"FixedVariableInterestRateType",
"AER"
]
},
"additionalProperties": false,
"minItems": 1
},
"CreditInterestEligibility": {
"description": "Eligibility for credit interest",
"type": "array",
"title": "CreditInterestEligibility",
"items": {
"description": "Eligibility for credit interest",
"type": "object",
"properties": {
"Name": {
"description": "Name provided for the eligibility criteria",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Description": {
"description": "Full description for the eligibility criteria",
"title": "Description",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Type": {
"description": "Eligility type - method by which we group eligibilities for comparison purposes.",
"title": "Type",
"type": "string",
"enum": [
"DirectDebits",
"ExistingCustomers",
"MinimumOperatingBalance",
"MinimumDeposit",
"NewCustomersOnly",
"PreviousBankruptcyAllowed",
"Other",
"StudentsOnly",
"SoleStudentAccount",
"SoleUkAccount",
"SwitchersOnly",
"UCASFulltimeTwoYears"
]
},
"Amount": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Any eligibility criteria where a long description is supplied",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Period": {
"description": "Period for which the other eligibility criteria applies.",
"title": "Period",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Optional additional notes to supplement the eligibility conditions.",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Non-standard eligibility type code.",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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": [
"Name",
"Type"
]
},
"additionalProperties": false
}
},
"required": [
"TierBandMethod",
"TierBand"
]
},
"additionalProperties": false,
"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": "string",
"minLength": 1,
"maxLength": 2000
},
"TcsAndCsURL": {
"description": "URL provided by the financial institution which redirects to the PCA Overdraft T&Cs on an external website",
"title": "TcsAndCsURL",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"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: 'Whole' Where the same charge\/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges\/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation '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": [
"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",
"Other"
]
},
"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 or unauthorised",
"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}$"
},
"OverdraftInterestChargingCoverage": {
"description": "Interestest charged on whole amount or tiered\/banded",
"title": "OverdraftInterestChargingCoverage",
"type": "string",
"enum": [
"Tiered",
"Whole"
]
},
"BankGuaranteedIndicator": {
"description": "Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically",
"title": "BankGuaranteedIndicator",
"type": "boolean"
},
"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}$"
},
"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",
"type": "array",
"title": "OverdraftFeeChargeCap",
"items": {
"description": "Details about any caps (maximum charges) that apply to a particular fee\/charge",
"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",
"EmergencyBorrowing",
"BorrowingItem",
"OverdraftRenewal",
"AnnualReview",
"OverdraftSetup",
"Surcharge",
"TempOverdraft",
"UnauthorisedBorrowing",
"UnauthorisedPaidTrans",
"UnauthorisedUnpaidTrans"
]
},
"minItems": 1
},
"OverdraftControlIndicator": {
"description": "Specifies for the overdraft control feature\/benefit",
"title": "OverdraftControlIndicator",
"type": "boolean"
},
"FeeMinMaxType": {
"description": "Indicates that this is the minimum\/ maximum fee\/charge that can be applied by the financial institution",
"title": "FeeMinMaxType",
"type": "string",
"enum": [
"Minimum",
"Maximum"
]
},
"FeeCapOccurrence": {
"description": "fee\/charges are captured dependent on the number of occurrences rather than capped at a particular amount",
"title": "FeeCapOccurrence",
"type": "number",
"format": "float"
},
"FeeCapAmount": {
"description": "Cap amount charged for a fee\/charge",
"title": "FeeCapAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"CappingPeriod": {
"description": "Period e.g. day, week, month etc. for which the fee\/charge is capped",
"title": "CappingPeriod",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Notes related to Overdraft fee charge cap",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherFeeType": {
"description": "Other fee type code which is not available in the standard code set",
"type": "array",
"title": "OtherFeeType",
"items": {
"description": "Other fee type code which is not available in the standard code set",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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
}
},
"required": [
"Name",
"Description"
]
},
"additionalProperties": false
}
},
"required": [
"FeeType",
"FeeMinMaxType"
]
},
"additionalProperties": false
},
"OverdraftFeeChargeDetail": {
"description": "Details about the fees\/charges",
"type": "array",
"title": "OverdraftFeeChargeDetail",
"items": {
"description": "Details about the fees\/charges",
"type": "object",
"properties": {
"FeeType": {
"description": "Overdraft fee type",
"title": "FeeType",
"type": "string",
"enum": [
"ArrangedOverdraft",
"EmergencyBorrowing",
"BorrowingItem",
"OverdraftRenewal",
"AnnualReview",
"OverdraftSetup",
"Surcharge",
"TempOverdraft",
"UnauthorisedBorrowing",
"UnauthorisedPaidTrans",
"UnauthorisedUnpaidTrans"
]
},
"OverdraftControlIndicator": {
"description": "Specifies for the overdraft control feature\/benefit",
"title": "OverdraftControlIndicator",
"type": "boolean"
},
"IncrementalBorrowingAmount": {
"description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied",
"title": "IncrementalBorrowingAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"FeeAmount": {
"description": "Amount charged for an overdraft fee\/charge (where it is charged in terms of an amount rather than a rate)",
"title": "FeeAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"FeeRate": {
"description": "Rate charged for overdraft fee\/charge (where it is charged in terms of a rate rather than an amount)",
"title": "FeeRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
},
"FeeRateType": {
"description": "Rate type for overdraft fee\/charge (where it is charged in terms of a rate rather than an amount)",
"title": "FeeRateType",
"type": "string",
"enum": [
"LinkedBaseRate",
"Gross",
"Net",
"Other"
]
},
"ApplicationFrequency": {
"description": "Frequency at which the overdraft charge is applied to the account",
"title": "ApplicationFrequency",
"type": "string",
"enum": [
"AccountClosing",
"AccountOpening",
"AcademicTerm",
"ChargingPeriod",
"Daily",
"PerItem",
"Monthly",
"OnAccountAnniversary",
"Other",
"PerHour",
"PerOccurrence",
"PerSheet",
"PerTransaction",
"PerTransactionAmount",
"PerTransactionPercentage",
"Quarterly",
"SixMonthly",
"StatementMonthly",
"Weekly",
"Yearly"
]
},
"CalculationFrequency": {
"description": "How often is the overdraft fee\/charge calculated for the account.",
"title": "CalculationFrequency",
"type": "string",
"enum": [
"AccountClosing",
"AccountOpening",
"AcademicTerm",
"ChargingPeriod",
"Daily",
"PerItem",
"Monthly",
"OnAccountAnniversary",
"Other",
"PerHour",
"PerOccurrence",
"PerSheet",
"PerTransaction",
"PerTransactionAmount",
"PerTransactionPercentage",
"Quarterly",
"SixMonthly",
"StatementMonthly",
"Weekly",
"Yearly"
]
},
"Notes": {
"description": "Free text for capturing any other info related to Overdraft Fees Charge Details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherFeeType": {
"description": "Other Fee type which is not available in the standard code set",
"type": "object",
"title": "OtherFeeType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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"
]
},
"OtherFeeRateType": {
"description": "Other fee rate type code which is not available in the standard code set",
"type": "object",
"title": "OtherFeeRateType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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 whithin 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 whithin 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"
]
},
"OverdraftFeeApplicableRange": {
"description": "Range or amounts or rates for which the fee\/charge applies",
"type": "object",
"title": "OverdraftFeeApplicableRange",
"properties": {
"MinimumAmount": {
"description": "Minimum Amount on which fee\/charge is applicable (where it is expressed as an amount)",
"title": "MinimumAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"MaximumAmount": {
"description": "Maximum Amount on which fee is applicable (where it is expressed as an amount)",
"title": "MaximumAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"MinimumRate": {
"description": "Minimum rate on which fee\/charge is applicable(where it is expressed as an rate)",
"title": "MinimumRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
},
"MaximumRate": {
"description": "Maximum rate on which fee\/charge is applicable(where it is expressed as an rate)",
"title": "MaximumRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
}
},
"additionalProperties": false
}
},
"required": [
"FeeType",
"ApplicationFrequency",
"CalculationFrequency"
]
},
"additionalProperties": false,
"minItems": 1
}
},
"required": [
"OverdraftFeeChargeDetail"
]
},
"additionalProperties": false
}
},
"required": [
"Identification",
"TierValueMin"
]
},
"additionalProperties": false,
"minItems": 1
},
"OverdraftFeesCharges": {
"description": "Overdraft fees and charges details",
"type": "array",
"title": "OverdraftFeesCharges",
"items": {
"description": "Overdraft fees and charges details",
"type": "object",
"properties": {
"OverdraftFeeChargeCap": {
"description": "Details about any caps (maximum charges) that apply to a particular fee\/charge",
"type": "array",
"title": "OverdraftFeeChargeCap",
"items": {
"description": "Details about any caps (maximum charges) that apply to a particular fee\/charge",
"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",
"EmergencyBorrowing",
"BorrowingItem",
"OverdraftRenewal",
"AnnualReview",
"OverdraftSetup",
"Surcharge",
"TempOverdraft",
"UnauthorisedBorrowing",
"UnauthorisedPaidTrans",
"UnauthorisedUnpaidTrans"
]
},
"minItems": 1
},
"OverdraftControlIndicator": {
"description": "Specifies for the overdraft control feature\/benefit",
"title": "OverdraftControlIndicator",
"type": "boolean"
},
"FeeMinMaxType": {
"description": "Indicates that this is the minimum\/ maximum fee\/charge that can be applied by the financial institution",
"title": "FeeMinMaxType",
"type": "string",
"enum": [
"Minimum",
"Maximum"
]
},
"FeeCapOccurrence": {
"description": "fee\/charges are captured dependent on the number of occurrences rather than capped at a particular amount",
"title": "FeeCapOccurrence",
"type": "number",
"format": "float"
},
"FeeCapAmount": {
"description": "Cap amount charged for a fee\/charge",
"title": "FeeCapAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"CappingPeriod": {
"description": "Period e.g. day, week, month etc. for which the fee\/charge is capped",
"title": "CappingPeriod",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Notes related to Overdraft fee charge cap",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherFeeType": {
"description": "Other fee type code which is not available in the standard code set",
"type": "array",
"title": "OtherFeeType",
"items": {
"description": "Other fee type code which is not available in the standard code set",
"type": "object",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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
}
},
"required": [
"Name",
"Description"
]
},
"additionalProperties": false
}
},
"required": [
"FeeType",
"FeeMinMaxType"
]
},
"additionalProperties": false
},
"OverdraftFeeChargeDetail": {
"description": "Details about the fees\/charges",
"type": "array",
"title": "OverdraftFeeChargeDetail",
"items": {
"description": "Details about the fees\/charges",
"type": "object",
"properties": {
"FeeType": {
"description": "Overdraft fee type",
"title": "FeeType",
"type": "string",
"enum": [
"ArrangedOverdraft",
"EmergencyBorrowing",
"BorrowingItem",
"OverdraftRenewal",
"AnnualReview",
"OverdraftSetup",
"Surcharge",
"TempOverdraft",
"UnauthorisedBorrowing",
"UnauthorisedPaidTrans",
"UnauthorisedUnpaidTrans"
]
},
"OverdraftControlIndicator": {
"description": "Specifies for the overdraft control feature\/benefit",
"title": "OverdraftControlIndicator",
"type": "boolean"
},
"IncrementalBorrowingAmount": {
"description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied",
"title": "IncrementalBorrowingAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"FeeAmount": {
"description": "Amount charged for an overdraft fee\/charge (where it is charged in terms of an amount rather than a rate)",
"title": "FeeAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"FeeRate": {
"description": "Rate charged for overdraft fee\/charge (where it is charged in terms of a rate rather than an amount)",
"title": "FeeRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
},
"FeeRateType": {
"description": "Rate type for overdraft fee\/charge (where it is charged in terms of a rate rather than an amount)",
"title": "FeeRateType",
"type": "string",
"enum": [
"LinkedBaseRate",
"Gross",
"Net",
"Other"
]
},
"ApplicationFrequency": {
"description": "Frequency at which the overdraft charge is applied to the account",
"title": "ApplicationFrequency",
"type": "string",
"enum": [
"AccountClosing",
"AccountOpening",
"AcademicTerm",
"ChargingPeriod",
"Daily",
"PerItem",
"Monthly",
"OnAccountAnniversary",
"Other",
"PerHour",
"PerOccurrence",
"PerSheet",
"PerTransaction",
"PerTransactionAmount",
"PerTransactionPercentage",
"Quarterly",
"SixMonthly",
"StatementMonthly",
"Weekly",
"Yearly"
]
},
"CalculationFrequency": {
"description": "How often is the overdraft fee\/charge calculated for the account.",
"title": "CalculationFrequency",
"type": "string",
"enum": [
"AccountClosing",
"AccountOpening",
"AcademicTerm",
"ChargingPeriod",
"Daily",
"PerItem",
"Monthly",
"OnAccountAnniversary",
"Other",
"PerHour",
"PerOccurrence",
"PerSheet",
"PerTransaction",
"PerTransactionAmount",
"PerTransactionPercentage",
"Quarterly",
"SixMonthly",
"StatementMonthly",
"Weekly",
"Yearly"
]
},
"Notes": {
"description": "Free text for capturing any other info related to Overdraft Fees Charge Details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherFeeType": {
"description": "Other Fee type which is not available in the standard code set",
"type": "object",
"title": "OtherFeeType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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"
]
},
"OtherFeeRateType": {
"description": "Other fee rate type code which is not available in the standard code set",
"type": "object",
"title": "OtherFeeRateType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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 whithin 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 whithin 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"
]
},
"OverdraftFeeApplicableRange": {
"description": "Range or amounts or rates for which the fee\/charge applies",
"type": "object",
"title": "OverdraftFeeApplicableRange",
"properties": {
"MinimumAmount": {
"description": "Minimum Amount on which fee\/charge is applicable (where it is expressed as an amount)",
"title": "MinimumAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"MaximumAmount": {
"description": "Maximum Amount on which fee is applicable (where it is expressed as an amount)",
"title": "MaximumAmount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"MinimumRate": {
"description": "Minimum rate on which fee\/charge is applicable(where it is expressed as an rate)",
"title": "MinimumRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
},
"MaximumRate": {
"description": "Maximum rate on which fee\/charge is applicable(where it is expressed as an rate)",
"title": "MaximumRate",
"type": "string",
"pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
}
},
"additionalProperties": false
}
},
"required": [
"FeeType",
"ApplicationFrequency",
"CalculationFrequency"
]
},
"additionalProperties": false,
"minItems": 1
}
},
"required": [
"OverdraftFeeChargeDetail"
]
},
"additionalProperties": false
}
},
"required": [
"TierBandMethod",
"Identification",
"OverdraftTierBand"
]
},
"additionalProperties": false,
"minItems": 1
}
},
"additionalProperties": false,
"required": [
"OverdraftTierBandSet"
]
},
"Eligibility": {
"description": "Eligibility details for this product i.e. the criteria that an accountholder has to meet in order to be eligible for the PCA product.",
"type": "object",
"title": "Eligibility",
"properties": {
"OtherEligibility": {
"description": "Other eligibility which is not covered by the main eligibility of the PCA product",
"type": "array",
"title": "OtherEligibility",
"items": {
"description": "Other eligibility which is not covered by the main eligibility of the PCA product",
"type": "object",
"properties": {
"Name": {
"description": "Name provided for the eligibility criteria",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Description": {
"description": "Full description for the eligibility criteria",
"title": "Description",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Type": {
"description": "Eligility type - method by which we group eligibilities for comparison purposes.",
"title": "Type",
"type": "string",
"enum": [
"DirectDebits",
"ExistingCustomers",
"MinimumOperatingBalance",
"MinimumDeposit",
"NewCustomersOnly",
"PreviousBankruptcyAllowed",
"Other",
"StudentsOnly",
"SoleStudentAccount",
"SoleUkAccount",
"SwitchersOnly",
"UCASFulltimeTwoYears"
]
},
"Amount": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Any eligibility criteria where a long description is supplied",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Period": {
"description": "Period for which the other eligibility criteria applies.",
"title": "Period",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Optional additional notes to supplement the eligibility conditions.",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Non-standard eligibility type code.",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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": [
"Name",
"Type"
]
},
"additionalProperties": false
},
"AgeEligibility": {
"description": "Age eligibility that a person should be to hold this account",
"type": "object",
"title": "AgeEligibility",
"properties": {
"MinimumAge": {
"description": "Minimum age that a person is eligible to hold this account",
"title": "MinimumAge",
"type": "number",
"format": "float"
},
"MaximumAge": {
"description": "Maximum age that a person is eligible to hold this account",
"title": "MaximumAge",
"type": "number",
"format": "float"
},
"Notes": {
"description": "Optional additional notes to supplement the AgeEligibility details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
}
},
"additionalProperties": false
},
"ResidencyEligibility": {
"description": "Countries in which an accountholder can reside and, therefore, be eligible to open an account",
"type": "object",
"title": "ResidencyEligibility",
"properties": {
"ResidencyType": {
"description": "Residency type like Tax residency, Owner residency etc.",
"title": "ResidencyType",
"type": "string",
"enum": [
"Householder",
"Other"
]
},
"ResidencyIncluded": {
"description": "Country code for which PCA product is allowed.",
"title": "ResidencyIncluded",
"type": "array",
"items": {
"description": "CodeMnemonic",
"type": "string",
"pattern": "^\\w{0,4}$",
"minLength": 0,
"maxLength": 4
},
"minItems": 1
},
"Notes": {
"description": "Optional additional notes to supplement the ResidencyEligibility details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherResidencyType": {
"description": "Other residency type which is not available in standard code list.",
"type": "object",
"title": "OtherResidencyType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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"
]
}
},
"additionalProperties": false,
"required": [
"ResidencyIncluded"
]
},
"CreditCheck": {
"description": "Credit check criteria that the account holder will need to meet to take out the PCA product",
"type": "object",
"title": "CreditCheck",
"properties": {
"ScoringType": {
"description": "Opening Credit Scoring Type (Hard or Soft)",
"title": "ScoringType",
"type": "string",
"enum": [
"Hard",
"Soft"
]
},
"Notes": {
"description": "Optional additional notes to supplement the CreditCheck details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
}
},
"additionalProperties": false
},
"IDVerificationCheck": {
"description": "Identity verification criteria that the account holder will need to meet to take out the PCA product",
"type": "object",
"title": "IDVerificationCheck",
"properties": {
"URL": {
"description": "URL to identity verification document list which is required for obtaining the product.",
"title": "URL",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Notes": {
"description": "Optional additional notes to supplement the ID Verification details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"FeaturesAndBenefits": {
"description": "Feature And Benefits Details",
"type": "object",
"title": "FeaturesAndBenefits",
"properties": {
"FeatureBenefitGroup": {
"description": "Used to group multiple features\/benefits where a charge is applied",
"type": "array",
"title": "FeatureBenefitGroup",
"items": {
"description": "Used to group multiple features\/benefits where a charge is applied",
"type": "object",
"properties": {
"Name": {
"description": "Feature\/Benefit Name",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Type": {
"description": "Common types of features & benefits",
"title": "Type",
"type": "string",
"enum": [
"AccountManagement",
"AccountOpeningOrSwitching Incentive",
"Cashback",
"Entertainment",
"HomeInsurance",
"HomeProtection",
"InternationalPaymentSupport",
"Lifestyle",
"MotorBreakdown",
"OverdraftControl",
"Other",
"PremiumService",
"PreferentialRates",
"PassiveSaving",
"RelationshipManager",
"Rewards",
"TechnologyInsurance",
"TravelInsurance",
"Travel"
]
},
"BenefitGroupNominalValue": {
"description": "BenefitGroupNominalValue is to allow banks to state what they feel their benefit package is worth",
"title": "BenefitGroupNominalValue",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Fee": {
"description": "Fee that is charged to the customer for a pack of features\/benefits",
"title": "Fee",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"ApplicationFrequency": {
"description": "How often is the charge for the feature\/benefit group applied to the customer account",
"title": "ApplicationFrequency",
"type": "string",
"enum": [
"PerAcademicTerm",
"Daily",
"HalfYearly",
"Monthly",
"Other",
"Quarterly",
"PerStatementDate",
"Weekly",
"Yearly"
]
},
"CalculationFrequency": {
"description": "How often is the charge for the feature\/benefit group calculated for the customer account",
"title": "CalculationFrequency",
"type": "string",
"enum": [
"PerAcademicTerm",
"Daily",
"HalfYearly",
"Monthly",
"Other",
"Quarterly",
"PerStatementDate",
"Weekly",
"Yearly"
]
},
"Notes": {
"description": "Optional additional notes to supplement the Feature Benefit Group details",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherApplicationFrequency": {
"description": "Other application frequency which is not available in the standard code set",
"type": "object",
"title": "OtherApplicationFrequency",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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 whithin 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"
]
},
"OtherType": {
"description": "Other common types of features & benefits which are not available in the standard code set",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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"
]
},
"FeatureBenefitItem": {
"description": "Detailed features or benefits which may or may not be a part of a feature\/benefit group\/pack",
"type": "array",
"title": "FeatureBenefitItem",
"items": {
"description": "Detailed features or benefits which may or may not be a part of a feature\/benefit group\/pack",
"type": "object",
"properties": {
"Identification": {
"description": "Unique and unambiguous identification of a Feature and Benefit Item.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Type": {
"description": "Common types of features & benefits",
"title": "Type",
"type": "string",
"enum": [
"AccountManagement",
"AccountOpeningOrSwitching Incentive",
"Cashback",
"Entertainment",
"HomeInsurance",
"HomeProtection",
"InternationalPaymentSupport",
"Lifestyle",
"MotorBreakdown",
"OverdraftControl",
"Other",
"PremiumService",
"PreferentialRates",
"PassiveSaving",
"RelationshipManager",
"Rewards",
"TechnologyInsurance",
"TravelInsurance",
"Travel"
]
},
"Name": {
"description": "Name which can be attached to the feature\/benefit",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Amount": {
"description": "Amount associated to the feature\/benefit where applicable e.g. 200 Pounds worth of travel insurance",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "True\/False indicator for a particular feature\/benefit e.g. Interest Free Overdraft?",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Provides textual information about a feature\/benefit e.g. 10% off cinema tickets on Tuesday nights",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Notes": {
"description": "Optional additional notes to supplement the feature\/benefit item. Only used for very specific conditions",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Other common types of features & benefits which are not available in the standard code set",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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"
]
},
"FeatureBenefitEligibility": {
"description": "Feature and Benefit eligibility",
"type": "array",
"title": "FeatureBenefitEligibility",
"items": {
"description": "Feature and Benefit eligibility",
"type": "object",
"properties": {
"Name": {
"description": "Name provided for the eligibility criteria",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Description": {
"description": "Full description for the eligibility criteria",
"title": "Description",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Type": {
"description": "Eligility type - method by which we group eligibilities for comparison purposes.",
"title": "Type",
"type": "string",
"enum": [
"DirectDebits",
"ExistingCustomers",
"MinimumOperatingBalance",
"MinimumDeposit",
"NewCustomersOnly",
"PreviousBankruptcyAllowed",
"Other",
"StudentsOnly",
"SoleStudentAccount",
"SoleUkAccount",
"SwitchersOnly",
"UCASFulltimeTwoYears"
]
},
"Amount": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Any eligibility criteria where a long description is supplied",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Period": {
"description": "Period for which the other eligibility criteria applies.",
"title": "Period",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Optional additional notes to supplement the eligibility conditions.",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Non-standard eligibility type code.",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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": [
"Name",
"Type"
]
},
"additionalProperties": false
}
},
"required": [
"Identification",
"Type"
]
},
"additionalProperties": false
},
"FeatureBenefitEligibility": {
"description": "Feature and Benefit eligibility",
"type": "array",
"title": "FeatureBenefitEligibility",
"items": {
"description": "Feature and Benefit eligibility",
"type": "object",
"properties": {
"Name": {
"description": "Name provided for the eligibility criteria",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Description": {
"description": "Full description for the eligibility criteria",
"title": "Description",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Type": {
"description": "Eligility type - method by which we group eligibilities for comparison purposes.",
"title": "Type",
"type": "string",
"enum": [
"DirectDebits",
"ExistingCustomers",
"MinimumOperatingBalance",
"MinimumDeposit",
"NewCustomersOnly",
"PreviousBankruptcyAllowed",
"Other",
"StudentsOnly",
"SoleStudentAccount",
"SoleUkAccount",
"SwitchersOnly",
"UCASFulltimeTwoYears"
]
},
"Amount": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Any eligibility criteria where a long description is supplied",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Period": {
"description": "Period for which the other eligibility criteria applies.",
"title": "Period",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Optional additional notes to supplement the eligibility conditions.",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Non-standard eligibility type code.",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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": [
"Name",
"Type"
]
},
"additionalProperties": false
}
},
"required": [
"Name"
]
},
"additionalProperties": false
},
"FeatureBenefitItem": {
"description": "Detailed features or benefits which may or may not be a part of a feature\/benefit group\/pack",
"type": "array",
"title": "FeatureBenefitItem",
"items": {
"description": "Detailed features or benefits which may or may not be a part of a feature\/benefit group\/pack",
"type": "object",
"properties": {
"Identification": {
"description": "Unique and unambiguous identification of a Feature and Benefit Item.",
"title": "Identification",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Type": {
"description": "Common types of features & benefits",
"title": "Type",
"type": "string",
"enum": [
"AccountManagement",
"AccountOpeningOrSwitching Incentive",
"Cashback",
"Entertainment",
"HomeInsurance",
"HomeProtection",
"InternationalPaymentSupport",
"Lifestyle",
"MotorBreakdown",
"OverdraftControl",
"Other",
"PremiumService",
"PreferentialRates",
"PassiveSaving",
"RelationshipManager",
"Rewards",
"TechnologyInsurance",
"TravelInsurance",
"Travel"
]
},
"Name": {
"description": "Name which can be attached to the feature\/benefit",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Amount": {
"description": "Amount associated to the feature\/benefit where applicable e.g. 200 Pounds worth of travel insurance",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "True\/False indicator for a particular feature\/benefit e.g. Interest Free Overdraft?",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Provides textual information about a feature\/benefit e.g. 10% off cinema tickets on Tuesday nights",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Notes": {
"description": "Optional additional notes to supplement the feature\/benefit item. Only used for very specific conditions",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Other common types of features & benefits which are not available in the standard code set",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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"
]
},
"FeatureBenefitEligibility": {
"description": "Feature and Benefit eligibility",
"type": "array",
"title": "FeatureBenefitEligibility",
"items": {
"description": "Feature and Benefit eligibility",
"type": "object",
"properties": {
"Name": {
"description": "Name provided for the eligibility criteria",
"title": "Name",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"Description": {
"description": "Full description for the eligibility criteria",
"title": "Description",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Type": {
"description": "Eligility type - method by which we group eligibilities for comparison purposes.",
"title": "Type",
"type": "string",
"enum": [
"DirectDebits",
"ExistingCustomers",
"MinimumOperatingBalance",
"MinimumDeposit",
"NewCustomersOnly",
"PreviousBankruptcyAllowed",
"Other",
"StudentsOnly",
"SoleStudentAccount",
"SoleUkAccount",
"SwitchersOnly",
"UCASFulltimeTwoYears"
]
},
"Amount": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.",
"title": "Amount",
"type": "string",
"pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$"
},
"Indicator": {
"description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident",
"title": "Indicator",
"type": "boolean"
},
"Textual": {
"description": "Any eligibility criteria where a long description is supplied",
"title": "Textual",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Period": {
"description": "Period for which the other eligibility criteria applies.",
"title": "Period",
"type": "string",
"enum": [
"Day",
"Half Year",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Notes": {
"description": "Optional additional notes to supplement the eligibility conditions.",
"title": "Notes",
"type": "array",
"items": {
"description": "maxLength 2000 text",
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"OtherType": {
"description": "Non-standard eligibility type code.",
"type": "object",
"title": "OtherType",
"properties": {
"Code": {
"description": "The four letter Mnemonic used whithin 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": [
"Name",
"Type"
]
},
"additionalProperties": false
}
},
"required": [
"Identification",
"Type"
]
},
"additionalProperties": false
},
"Card": {
"description": "Payment Card Details",
"type": "array",
"title": "Card",
"items": {
"description": "Payment Card Details",
"type": "object",
"properties": {
"Type": {
"description": "Card Type available e.g. Debit",
"title": "Type",