Resources
ATMs
This API will return data about all our ATMs and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ATMDefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [ATMDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all ATMs in the specified town. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
town
|
string |
Town name, not case sensitive |
country
|
string |
The ISO country code e.g. "GB" |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ATMDefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [ATMDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all ATMs in the specified country. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
country
|
string |
The ISO country code e.g. "GB" |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ATMDefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [ATMDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will data about all ATMs within a specified radius (1 to 10 miles) of the specified latitude and longitude. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
longitude
|
string |
Positive or negative decimal value in degrees. eg "-0.0180120225995" |
latitude
|
string |
Positive or negative decimal value in degrees. eg "51.50551621597067" |
Query
| Name | Data Type | Description |
|---|---|---|
radius
|
double |
Number of miles (1 to 10) as an integer. Default = 1 |
Responses
Body
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [ATMDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all ATMs within a 5 mile radius of the specified postcode. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
postcode
|
string |
Letters and numerals only. No spaces or special characters. eg "SW1A1AA" |
Responses
Body
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [ATMDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Branches
This API will return the branch details for all branches and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BranchDefinitionMeta
|
Properties
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return the branch details for all branches in the specified town. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
town
|
string |
Town name, not case sensitive |
country
|
string |
The ISO country code e.g. "GB" |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BranchDefinitionMeta
|
Properties
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return the branch details for all branches in the specified country. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
country
|
string |
The ISO country code e.g. "GB" |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BranchDefinitionMeta
|
Properties
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This API will return the branch details for all branches within a specified radius (1 to 10 miles) of the specified latitude and longitude. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
longitude
|
string |
Positive or negative decimal value in degrees. eg "-0.0180120225995" |
latitude
|
string |
Positive or negative decimal value in degrees. eg "51.50551621597067" |
Query
| Name | Data Type | Description |
|---|---|---|
radius
|
double |
Number of miles (1 to 10) as an integer. Default = 1 |
Responses
Body
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return the branch details for all branches within a 5 mile radius of the specified postcode. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
postcode
|
string |
Letters and numerals only. No spaces or special characters. eg. "SW1A1AA" |
Responses
Body
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
body
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return the branch details for a branch specified by its sort code. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
sortcode
|
string |
6 digit number with no spaces or special characters. eg. "400003" |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BranchDefinitionMeta
|
Properties
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Products BCA
This API will return data about all BCA productsand is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BCADefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BCADefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all BCA products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
segment
|
string |
Segment name from this list: "Basic", "Business", "General", "Graduate", "International", "Packaged", "Personal", "Premium", "Reward", "SME", "Student", "YoungAdult", "Youth". |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BCADefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BCADefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Products Commercial Credit Cards
This API will return data about all commercial credit cards productsand is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CCCDefinitionMeta
|
Properties
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [CCCDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all commercial credit cards products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
segment
|
string |
Segment name from this list: "Cashback", "Corporate", "General", "Reward", "SME". |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CCCDefinitionMeta
|
Properties
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [CCCDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Products PCA
This API will return data about all PCA productsand is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
Responses
Body
| Name | Data Type | Description |
|---|---|---|
PCADefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [PCADefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all PCA products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
segment
|
string |
Segment name from this list: "Basic", "Business", "General", "Graduate", "International", "Packaged", "Personal", "Premium", "Reward", "SME", "Student", "YoungAdult", "Youth". |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
PCADefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [PCADefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Products SME Lending
This API will return data about all SME lending productsand is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.
Responses
Body
| Name | Data Type | Description |
|---|---|---|
SMELendingDefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [SMELendingDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
This extended API will return data about all SME lending products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 1.2.4. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.
Request
Path
| Name | Data Type | Description |
|---|---|---|
segment
|
string |
Segment name from this list: "AgricultureSector", "AllSegmentsCorporate", "Corporate", "FixedGroup", "FlexibleBusinessLoan", "GovernmentScheme", "NewCustomersOnly", "SmallLoan", "SpecialisedSector", "SwitchersOnly". |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
SMELendingDefinitionMeta
|
Properties
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [SMELendingDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
400 Error object
|
object |
Properties
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Body
| Name | Data Type | Description |
|---|---|---|
408 Error object
|
object |
Properties
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Body
| Name | Data Type | Description |
|---|---|---|
429 Error object
|
object |
Properties
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Body
| Name | Data Type | Description |
|---|---|---|
500 Error object
|
object |
Properties
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Body
| Name | Data Type | Description |
|---|---|---|
503 Error object
|
object |
Properties
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Models
Properties
| Name | Data Type | Description |
|---|---|---|
SupportedLanguages
|
array [string] |
Languages that the ATM supports |
SiteName
|
string Minimum: 1 Maximum: 35 |
Site identifying name, where ATM is located |
SiteID
|
string Minimum: 1 Maximum: 35 |
Site identifying code, where ATM is located |
Organisation
|
||
MinimumValueDispensed
|
string Allowed values: - £5- £10- £20- £50- £100 |
Minimum currency denominations usually available |
LocationCategory
|
string Allowed values: - Airport- BankSpecialisedOutlet- BranchExternal- BranchInternal- BranchLobby- BureauDeChange- CoachStation- CommercialSpaceInternal- ConvenienceStore- ExhibitionCentre- FactoryOrOffice- FillingStation- FinancialInstitution- GovernmentOffice- Hospital- Hotel- KioskPod- LeisureCentre- PleasurePark- PublicHouse- RailwayStation- RemoteUnit- RetailerDepartmentStore- RetailerOutlet- SeaportTerminal- ServiceStation- ShoppingCentreExternal- ShoppingCentreInternal- StorageDepot- SupermarketExternal- SupermarketInternal- UndergroundRailwayStation- UniversityOrCollege |
Indicates the environment of the ATM |
GeographicLocation
|
||
Currency
|
array [string] Pattern: [A-Z]{3}
|
Defines currency type available for dispense |
BranchIdentification
|
string Minimum: 1 Maximum: 35 |
Unique and unambiguous identification of a retail branch of a financial institution |
Address
|
||
AdditionalATMServices
|
array [string] Minimum: 1 Maximum: 350 |
ATM Service Description |
AccessibilityTypes
|
array [string] Allowed values: - AudioCashMachine- AutomaticDoors- ChairAccess- DriveThru- ExternalRamp- InductionLoop- InternalRamp- LevelAccess- LowerLevelCounter- WheelchairAccess |
Information about the accessibility |
ATMServices
|
array [string] Allowed values: - Balance- BillPayments- CashDeposits- CashWithdrawal- CharityDonation- ChequeBookRequest- ChequeDeposits- FastCash- MiniStatement- MobileBankingRegistration- MobilePaymentRegistration- MobilePhoneTopUp- OrderStatement- PINActivation- PINChange |
Information about ATM services |
ATMID
|
string Minimum: 1 Maximum: 35 |
ATM terminal device identification for the acquirer and the issuer |
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [ATMDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
Business current account
Properties
| Name | Data Type | Description |
|---|---|---|
TsandCs
|
array [string] |
URL provided by the parent organisation which redirects to the current T&Cs |
ProductURL
|
array [uri] |
URL provided by the organisation which redirects to the product (on live products only). There might be more than one product at a given URL |
ProductType
|
string Allowed values: - BCA |
Descriptive code for the product category |
ProductSegment
|
array [string] Allowed values: - Basic- Business- General- Graduate- International- Packaged- Personal- Premium- Reward- SME- Student- YoungAdult- Youth |
|
ProductName
|
string |
The name of the product used for marketing purposes from a customer perspective. i.e. what the customer would recognise |
ProductIdentifier
|
string |
Identifier within the parent organisation for the product. Must be unique in the organisation |
ProductDescription
|
string |
Description of the product provided by the parent organisation |
OverdraftOffered
|
boolean |
Indicates whether an overdraft offered for this account |
Overdraft
|
array [object] | |
Organisation
|
||
MobileWallet
|
array [string] Allowed values: - AndroidPay- ApplePay- IssuerMobileApp- MobileBankingApp- Other- PayM- SamsungPay- VodafoneWallet |
Mobile wallet supported by this product. A mobile wallet being any electronic device that allows an individual to make electronic commerce transactions |
MaximumMonthlyCharge
|
string Pattern: ^-?\d{1,10}\.\d{1,2}$
|
The maximum Relevant Charges that could accrue |
InternationalPaymentsSupported
|
boolean |
Indicates that the account supports international payments |
FeesAndCharges
|
array [object] Minimum: 1 |
|
Feature
|
array [object] | |
Eligibility
|
||
Currency
|
array [string] Pattern: [A-Z]{3}
|
Currency of the Account. Default to GBP at present |
CreditScoringPartOfAccountOpeningText
|
string |
Details on the specific credit scoring |
CreditScoringPartOfAccountOpeningIsAHardOrSoftCreditScore
|
array [string] Allowed values: - Hard- Soft |
Describes the type of credit scoring |
CreditScoringPartOfAccountOpeningIDVerificationText
|
array [string] |
Details on the specific credit scoring |
CreditScoringPartOfAccountOpeningIDVerificationIsAHardOrSoftCreditScore
|
array [string] Allowed values: - Hard- Soft |
|
CreditScoringPartOfAccountOpeningForIDVerification
|
boolean |
Indicates whether a credit check is used to check the address of a potential new account holder |
CreditScoringPartOfAccountOpeningForGettingAnAccount
|
boolean |
Indicates whether a credit check performed on an inquiry to open an account is submitted |
CreditInterest
|
||
Contactless
|
boolean |
Does the card issued have contactless facility |
ChequeBookAvailable
|
boolean |
Can a chequebook be issued |
CardWithdrawalLimit
|
string Pattern: ^-?\d{1,10}\.\d{1,2}$
|
The daily Limit that a customer can get via the ATM. This describes the default limit rather than the maximum |
CardType
|
array [string] Allowed values: - BasicCard- BusinessQuickLodgeCard- Cashcard- ContactlessCashcard- ContactlessDebitMastercard- ContactlessDebitVisa- DebitMastercard- VisaDebit- DepositCard- OperatorCard- POCACard |
Card Type available |
CardNotes
|
string |
Optional additional notes to supplement the card details |
CAPricing
|
array [object] Minimum: 1 |
|
Benefits
|
||
AccessChannels
|
array [string] Allowed values: - ATM- Branch- BusinessCommercialCentre- CallCentre- MobileApps- MobileBanking- Online- Phone- Post- PostOffice- RelationshipManager- Text |
Ways to interact with the bank when managing account |
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BCADefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description |
|---|---|---|
TelephoneNumber
|
string Pattern: ^[+][0-9]{1,3}-[0-9()+-]{1,30}$
|
Collection of information that identifies a phone number, as defined by telecom services. |
StopName
|
string Minimum: 1 Maximum: 15 |
Name of the stop of the mobile branch |
PlannedBranchClosure
|
array [object] | |
ParkingLocation
|
string Minimum: 1 Maximum: 50 |
Place where the mobile branch is located, such as between the news agent and the church. |
Organisation
|
||
OpeningTimes
|
array [object] Minimum: 1 |
Branch Opening Times |
GeographicLocation
|
||
FaxNumber
|
array [string] Pattern: ^[+][0-9]{1,3}-[0-9()+-]{1,30}$
|
Collection of information that identifies a FAX number, as defined by telecom services. |
DepartureTime
|
string Pattern: ^(([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9].\d{3})|(^24:00:00\.000)(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$
|
Time that the mobile branch is scheduled to depart |
DaysOfTheWeek
|
string Minimum: 1 Maximum: 35 |
Description on when the mobile branch is available. e.g. The weekend of Glastonbury festival; or Mondays and during the shrimp season also Wednesdays |
CustomerSegment
|
array [string] Allowed values: - Business- Corporate- Personal- Premier- Private- Select- SME- Wealth |
Customer segment which the branch is able to service |
BranchType
|
string Allowed values: - Physical- Mobile |
Information on the type of branch |
BranchSelfServeServiceName
|
array [string] Allowed values: - AccountVerificationService- AssistedServiceCounter- BusinessDepositTerminal- CashChequeDepositMachineCoin- CashChequeDepositMachineNoCoin- ExternalAtmAudio- ExternalAtmNoAudio- ExternalQuickServicePoint- InternalAtmAudio- InternalAtmNoAudio- InternalQuickServicePoint- LodgementDevice- OnlineBankingPoint- QuickDeposit- SaturdayCounterService- SelfServiceAccountOpening- StatementPrinter |
|
BranchPhoto
|
uri |
Image related to the branch |
BranchOtherSelfServices
|
array [string] Minimum: 1 Maximum: 350 |
Self Services not described in BranchSelfServeServiceName |
BranchOtherMediatedServices
|
array [string] Minimum: 1 Maximum: 350 |
Mediated Services not described in BranchMediatedServiceName |
BranchOtherFacilities
|
array [string] Minimum: 1 Maximum: 350 |
Any other facilities not mentioned in BranchFacilitiesName |
BranchName
|
string Minimum: 1 Maximum: 35 |
Name by which a party is known and which is usually used to identify that party |
BranchMediatedServiceName
|
array [string] Allowed values: - BureauDeChange- BusinessCounter- CardIssuanceFacility- CounterServices- DriveThru- MortgageAdvisor- NightSafe- OnDemandCurrency- PremierCounter- VideoBanking- WheelChairAccess |
Information about mediated branch facilities |
BranchIdentification
|
string Minimum: 1 Maximum: 35 |
Unique and unambiguous identification of a retail branch of a financial institution |
BranchFacilitiesName
|
array [string] Allowed values: - BusinessITSupport- CollectionLockers- MeetingRooms- Parking- Wifi |
Information about branch facilities |
BranchDescription
|
string Minimum: 1 Maximum: 140 |
Description of the branch |
ArrivalTime
|
string Pattern: ^(([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9].\d{3})|(^24:00:00\.000)(?:Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$
|
Time that the mobile branch is scheduled to arrive |
AlternatePhone
|
array [object] | |
Address
|
||
AccessibilityTypes
|
string Allowed values: - AudioCashMachine- AutomaticDoors- ChairAccess- DriveThru- ExternalRamp- InductionLoop- InternalRamp- LevelAccess- LowerLevelCounter- WheelchairAccess |
Information about the accessibility |
ATMAtBranch
|
boolean |
Indicated whether an ATM is at the branch |
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [BranchDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Commercial Credit Card
Properties
| Name | Data Type | Description |
|---|---|---|
TsandCs
|
array [string] |
URL provided by the parent organisation which redirects to the current T&Cs. Only applies on live products |
ProductURL
|
array [uri] |
URL provided by the organisation which redirects to the product (on live products only). There might be more than one product at a given URL |
ProductType
|
string Allowed values: - CommercialCreditCards |
Descriptive code for the product category |
ProductSegment
|
array [string] Allowed values: - Cashback- Corporate- General- Reward- SME |
Marketing or industry segment that the product is designed for |
ProductName
|
string |
Name of the Commercial Credit Card |
ProductIdentifier
|
string |
Identifier within the parent organisation for the product. Must be unique in the organisation |
PaymentHolidayDescription
|
string |
Detailed description on the payment holiday if available |
PaymentHoliday
|
boolean |
Indicates whether a payment holiday is possible |
OtherKeyFeatures
|
string |
Additional Features of the card |
Organisation
|
||
KeyFeatures
|
string |
Product key features |
Eligibility
|
||
Details
|
||
Description
|
string |
Product description |
Benefits
|
Properties
| Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
meta
|
MetaDefinition | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [CCCDefinition] | ||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
| Name | Data Type | Description |
|---|---|---|
title
|
string Allowed values: - Bad request |
|
status
|
string Allowed values: - 400 |
|
description
|
string Allowed values: - You have sent a request which could not be understood. |
Properties
| Name | Data Type | Description |
|---|---|---|
title
|
string Allowed values: - Client timeout |
|
status
|
string Allowed values: - 408 |
|
description
|
string Allowed values: - Your client has failed to submit a request, and a timeout has occurred. |
Properties
| Name | Data Type | Description |
|---|---|---|
title
|
string Allowed values: - Too many requests |
|
status
|
string Allowed values: - 429 |
|
description
|
string Allowed values: - You have requested this resource too often. Slow down. |
Properties
| Name | Data Type | Description |
|---|---|---|
title
|
string Allowed values: - Internal server error |
|
status
|
string Allowed values: - 500 |
|
description
|
string Allowed values: - An error occurred on the server. No further information is available. |
Properties
| Name | Data Type | Description |
|---|---|---|
title
|
string Allowed values: - Service temporarily unavailable |
|
status
|
string Allowed values: - 503 |
|
description
|
string Allowed values: - The service is temporarily unavailable. |
Properties
| Name | Data Type | Description |
|---|---|---|
TotalResults
|
integer | |
TermsOfUse
|
uri Allowed values: - https://openbanking.org.uk/terms |
Open Banking Terms of Use |
License
|
uri Allowed values: - https://openbanking.org.uk/open-licence |
Open Banking License |
LastUpdated
|
dateTime | |
Agreement
|
string Allowed values: - Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms and conditions |
Personal Current Account
Properties
| Name | Data Type | Description |
|---|---|---|
TsandCs
|
array [string] |
URL provided by the parent organisation which redirects to the current T&Cs |
ProductURL
|
array [uri] |
URL provided by the organisation which redirects to the product (on live products only). There might be more than one product at a given URL |
ProductType
|
string Allowed values: - PCA |
Descriptive code for the product category |
ProductSegment
|
array [string] Allowed values: - Basic- Business- General- Graduate- International- Packaged- Personal- Premium- Reward- SME- Student- YoungAdult- Youth |
|
ProductName
|
string |
The name of the product used for marketing purposes from a customer perspective. i.e. what the customer would recognise |
ProductIdentifier
|
string |
Identifier within the parent organisation for the product. Must be unique in the organisation |
ProductDescription
|
string |
Description of the product provided by the parent organisation |
OverdraftOffered
|
boolean |
Indicates whether an overdraft offered for this account |
Overdraft
|
array [object] | |
Organisation
|
||
MobileWallet
|
array [string] Allowed values: - AndroidPay- ApplePay- IssuerMobileApp- MobileBankingApp- Other- PayM- SamsungPay- VodafoneWallet |
Mobile wallet supported by this product. A mobile wallet being any electronic device that allows an individual to make electronic commerce transactions |
MaximumMonthlyCharge
|
string Pattern: ^-?\d{1,10}\.\d{1,2}$
|
The maximum Relevant Charges that could accrue |
InternationalPaymentsSupported
|
boolean |
Indicates that the account supports international payments |
FeesAndCharges
|
array [object] Minimum: 1 |
|
Feature
|
array [object] | |
Eligibility
|
||
Currency
|
array [string] Pattern: [A-Z]{3}
|
Currency of the Account. Default to GBP at present |
CreditScoringPartOfAccountOpeningText
|
string |
Details on the specific credit scoring |
CreditScoringPartOfAccountOpeningIsAHardOrSoftCreditScore
|
array [string] Allowed values: - Hard- Soft |
Describes the type of credit scoring |
CreditScoringPartOfAccountOpeningIDVerificationText
|
array [string] |
Details on the specific credit scoring |
CreditScoringPartOfAccountOpeningIDVerificationIsAHardOrSoftCreditScore
|
array [string] Allowed values: - Hard- Soft |
|
CreditScoringPartOfAccountOpeningForIDVerification
|
boolean |
Indicates whether a credit check is used to check the address of a potential new account holder |
CreditScoringPartOfAccountOpeningForGettingAnAccount
|
boolean |
Indicates whether a credit check performed on an inquiry to open an account is submitted |
CreditInterest
|
||
Contactless
|
boolean |
Does the card issued have contactless facility |
ChequeBookAvailable
|
boolean |
Can a chequebook be issued |
CardWithdrawalLimit
|
string Pattern: ^-?\d{1,10}\.\d{1,2}$
|
The daily Limit that a customer can get via the ATM. This describes the default limit rather than the maximum |
CardType
|
array [string] Allowed values: - BasicCard- BusinessQuickLodgeCard- Cashcard- ContactlessCashcard- ContactlessDebitMastercard- ContactlessDebitVisa- DebitMastercard- VisaDebit- DepositCard- OperatorCard- POCACard |
Card Type available |
CardNotes
|
string |
Optional additional notes to supplement the card details |
CAPricing
|
array [object] Minimum: 1 |
|
Benefits
|
||
AccessChannels
|
array [string] Allowed values: - ATM- Branch- BusinessCommercialCentre- CallCentre- MobileApps- MobileBanking- Online- Phone- Post- PostOffice- RelationshipManager- Text |
Ways to interact with the bank when managing account |
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [PCADefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SME Loan
Properties
| Name | Data Type | Description |
|---|---|---|
TsandCs
|
array [string] |
URL provided by the parent organisation which redirects to the T&Cs |
ProductURL
|
array [uri] | |
ProductTypeName
|
string Allowed values: - FlexibleBusinessLoan- SmallBusinessLoan- SmeUnsecuredLoan |
Descriptive code for the product category |
ProductSegment
|
array [string] Allowed values: - AgricultureSector- AllSegmentsCorporate- Corporate- FixedGroup- FlexibleBusinessLoan- GovernmentScheme- NewCustomersOnly- SmallLoan- SpecialisedSector- SwitchersOnly |
|
ProductName
|
string |
The short product or marketing name assigned by the parent organisation |
ProductIdentifier
|
string |
Identifier within the parent organisation for the product. Must be unique in the organisation |
ProductDescription
|
string |
Description of the product provided by the parent Organisation |
PaymentHoliday
|
boolean |
Indicates whether a repayment holiday is allowed |
Organisation
|
||
MinimumLoanTerm
|
integer |
Minimum term (Days) |
MinimumLoanAmount
|
string Pattern: ^-?\d{1,10}\.\d{1,2}$
|
Minimum loan amount |
MaximumLoanTerm
|
integer |
Maximum loan term (Days) |
MaximumLoanAmount
|
string Pattern: ^-?\d{1,10}\.\d{1,2}$
|
Maximum loan amount |
LoanItem
|
array [object] | |
FeesAndCharges
|
array [object] Minimum: 1 |
|
Eligibility
|
||
CustomerAccessChannels
|
array [string] Allowed values: - Branch- MobileBankingApp- Online- Phone- Post- PostOffice- Text |
Ways to interact with the bank |
Currency
|
array [string] Pattern: [A-Z]{3}
|
Currency of the Account. Default to GBP at present |
Benefits
|
||
ArrearsTreatment
|
string |
Arrears treatment |
Properties
| Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
meta
|
MetaDefinition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data
|
array [SMELendingDefinition] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authentication
Contact
@HSBC_UK |
Metadata (Technical Details)
| Origin - Format | swagger |
| Origin - Url | https://developer.hsbc.com/swagger/combined-api.json |
| Origin - Version | 2.0 |
| Provider Name | hsbc.com |
| API Version | 1.0.0 |