Skip to content

Commit

Permalink
Update docs (cont'd)
Browse files Browse the repository at this point in the history
  • Loading branch information
@markm77
markm77 committed Sep 18, 2023
1 parent 1fbed4c commit cd2e451
Show file tree
Hide file tree
Showing 9 changed files with 37 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/apis/account-and-transaction/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Account and Transaction API",
"description": "Account and Transaction API for Open Banking Connector Web App",
"version": "6.2.0"
"version": "6.3.1"
},
"paths": {
"/aisp/account-access-consent-auth-contexts": {
Expand Down
11 changes: 5 additions & 6 deletions docs/apis/auth-contexts/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Auth Contexts API",
"description": "Auth Contexts API for Open Banking Connector Web App",
"version": "6.2.0"
"version": "6.3.1"
},
"paths": {
"/auth/redirect-delegate": {
Expand Down Expand Up @@ -124,12 +124,11 @@
},
"ConsentType": {
"enum": [
0,
1,
2
"AccountAccessConsent",
"DomesticPaymentConsent",
"DomesticVrpConsent"
],
"type": "integer",
"format": "int32"
"type": "string"
}
}
}
Expand Down
3 changes: 2 additions & 1 deletion docs/apis/bank-configuration/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Bank Configuration API",
"description": "Bank Configuration API for Open Banking Connector Web App",
"version": "6.2.0"
"version": "6.3.1"
},
"paths": {
"/config/bank-registrations": {
Expand Down Expand Up @@ -167,6 +167,7 @@
"enum": [
"DbTransitionalDefault",
"Obie_Modelo",
"Obie_Model2023",
"NatWest_NatWestSandbox",
"NatWest_NatWest",
"NatWest_NatWestBankline",
Expand Down
3 changes: 2 additions & 1 deletion docs/apis/payment-initiation/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Payment Initiation API",
"description": "Payment Initiation API for Open Banking Connector Web App",
"version": "6.2.0"
"version": "6.3.1"
},
"paths": {
"/pisp/domestic-payment-consent-auth-contexts": {
Expand Down Expand Up @@ -322,6 +322,7 @@
"enum": [
"DbTransitionalDefault",
"Obie_Modelo",
"Obie_Model2023",
"NatWest_NatWestSandbox",
"NatWest_NatWest",
"NatWest_NatWestBankline",
Expand Down
3 changes: 2 additions & 1 deletion docs/apis/variable-recurring-payments/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Variable Recurring Payments API",
"description": "Variable Recurring Payments API for Open Banking Connector Web App",
"version": "6.2.0"
"version": "6.3.1"
},
"paths": {
"/vrp/domestic-vrp-consents": {
Expand Down Expand Up @@ -296,6 +296,7 @@
"enum": [
"DbTransitionalDefault",
"Obie_Modelo",
"Obie_Model2023",
"NatWest_NatWestSandbox",
"NatWest_NatWest",
"NatWest_NatWestBankline",
Expand Down
14 changes: 7 additions & 7 deletions docs/bank-integrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ UK Open Banking uses the [Financial-grade API](https://openid.net/specs/openid-f

In Open Banking Connector banks are identified by bank profiles. These are also given below.

| Bank Group | Brand/App (OIDC Issuer) | Sandbox? | Bank Profile | APIs |
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
| HSBC | FirstDirect<br>UK Personal<br>UK Business<br>UK Kinetic<br>HSBCnet UK | :white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | Hsbc_FirstDirect<br>Hsbc_UkPersonal<br>Hsbc_UkBusiness<br>Hsbc_UkKinetic<br>Hsbc_HsbcNetUk | AISP |
| Lloyds | Sandbox<br>Lloyds Personal<br>Lloyds Business<br>Lloyds Commercial<br>Halifax Personal<br>Bank&nbsp;of&nbsp;Scotland&nbsp;Personal<br>Bank&nbsp;of&nbsp;Scotland&nbsp;Business<br>Bank&nbsp;of&nbsp;Scotland&nbsp;Commercial<br>MBNA Personal | :white_check_mark:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | Lloyds_Sandbox<br>Lloyds_LloydsPersonal<br>Lloyds_LloydsBusiness<br>Lloyds_LloydsCommerical<br>Lloyds_HalifaxPersonal<br>Lloyds_BankOfScotlandPersonal<br>Lloyds_BankOfScotlandBusiness<br>Lloyds_BankOfScotlandCommerical<br>Lloyds_MbnaPersonal | AISP |
| NatWest | NatWest Sandbox<br>RBS Sandbox<br>NatWest<br>NatWest Bankline<br>NatWest ClearSpend<br>RBS<br>RBS Bankline<br>RBS ClearSpend<br>The One<br>NatWest One<br>Virgin One<br>Ulster Bank NI<br>Ulster Bank NI Bankline<br>Ulster&nbsp;Bank&nbsp;NI&nbsp;ClearSpend<br>Mettle<br>Coutts | :white_check_mark:<br>:white_check_mark:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | NatWest_NatWestSandbox<br>NatWest_RoyalBankOfScotlandSandbox<br>NatWest_NatWest<br>NatWest_NatWestBankline<br>NatWest_NatWestClearSpend<br>NatWest_RoyalBankOfScotland<br>NatWest_RoyalBankOfScotlandBankline<br>NatWest_RoyalBankOfScotlandClearSpend<br>NatWest_TheOne<br>NatWest_NatWestOne<br>NatWest_VirginOne<br>NatWest_UlsterBankNi<br>NatWest_UlsterBankNiBankline<br>NatWest_UlsterBankNiClearSpend<br>NatWest_Mettle<br>NatWest_Coutts | AISP |
| OBIE | Modelo | :white_check_mark: | Obie_Modelo | AISP, PISP |

| Bank Group | Brand/App (OIDC Issuer) | Sandbox? | Bank Profile | APIs |
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|
| Barclays | Personal<br>Wealth<br>Barclaycard<br>Business<br>Corporate<br>Barclaycard&nbsp;Commercial&nbsp;Payments | :white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | Barclays_Personal<br>Barclays_Wealth<br>Barclays_Barclaycard<br>Barclays_Business<br>Barclays_Corporate<br>Barclays_BarclaycardCommercialPayments | AISP |
| HSBC | FirstDirect<br>UK Personal<br>UK Business<br>UK Kinetic<br>HSBCnet UK | :white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | Hsbc_FirstDirect<br>Hsbc_UkPersonal<br>Hsbc_UkBusiness<br>Hsbc_UkKinetic<br>Hsbc_HsbcNetUk | AISP |
| Lloyds | Sandbox<br>Lloyds Personal<br>Lloyds Business<br>Lloyds Commercial<br>Halifax Personal<br>Bank&nbsp;of&nbsp;Scotland&nbsp;Personal<br>Bank&nbsp;of&nbsp;Scotland&nbsp;Business<br>Bank&nbsp;of&nbsp;Scotland&nbsp;Commercial<br>MBNA Personal | :white_check_mark:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | Lloyds_Sandbox<br>Lloyds_LloydsPersonal<br>Lloyds_LloydsBusiness<br>Lloyds_LloydsCommerical<br>Lloyds_HalifaxPersonal<br>Lloyds_BankOfScotlandPersonal<br>Lloyds_BankOfScotlandBusiness<br>Lloyds_BankOfScotlandCommerical<br>Lloyds_MbnaPersonal | AISP |
| NatWest | NatWest Sandbox<br>RBS Sandbox<br>NatWest<br>NatWest Bankline<br>NatWest ClearSpend<br>RBS<br>RBS Bankline<br>RBS ClearSpend<br>The One<br>NatWest One<br>Virgin One<br>Ulster Bank NI<br>Ulster Bank NI Bankline<br>Ulster&nbsp;Bank&nbsp;NI&nbsp;ClearSpend<br>Mettle *(under test)*<br>Coutts *(under test)* | :white_check_mark:<br>:white_check_mark:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square:<br>:white_large_square: | NatWest_NatWestSandbox<br>NatWest_RoyalBankOfScotlandSandbox<br>NatWest_NatWest<br>NatWest_NatWestBankline<br>NatWest_NatWestClearSpend<br>NatWest_RoyalBankOfScotland<br>NatWest_RoyalBankOfScotlandBankline<br>NatWest_RoyalBankOfScotlandClearSpend<br>NatWest_TheOne<br>NatWest_NatWestOne<br>NatWest_VirginOne<br>NatWest_UlsterBankNi<br>NatWest_UlsterBankNiBankline<br>NatWest_UlsterBankNiClearSpend<br>NatWest_Mettle<br>NatWest_Coutts | AISP |
| OBIE | Modelo<br>Model Bank (2023) *(under test)* | :white_check_mark:<br>:white_check_mark: | Obie_Modelo <br>Obie_Model2023 | AISP |
1 change: 1 addition & 0 deletions docs/get-started/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ We first show how to get Open Banking Connector up and running, then demonstrate
## Get Open Banking Connector up and running

To get Open Banking Connector up and running, you will need to do the following:

1. [set up configuration and secrets](./set-up-configuration-and-secrets/README.md)
2. [pull and run the Open Banking Connector Docker image](./run-docker-image/README.md)

Expand Down
12 changes: 7 additions & 5 deletions docs/get-started/set-up-configuration-and-secrets/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,24 @@ OpenBankingConnector__Custom__PostgreSqlPassword=placeholder # example arbitrary

Almost all bank profile information is supplied via source code.

However, some key information such as org IDs and URLs is only available to those registered with the UK Open Banking Directory. This information needs to be provided via configuration to complete the bank profile definitions.
However sometimes key information such as org IDs and URLs cannot be obtained from public sources and is only available to those registered with the UK Open Banking Directory or from bank dev portals. This information needs to be provided via configuration to complete the bank profile definitions.

When using a bank profile for the first time, if any required information from configuration is not available, Open Banking Connector will provide an error with details.
*Important: It is only necessary to provide information that relates to bank profiles you want to use.* When using a bank profile for the first time, if any required information from configuration is not available, Open Banking Connector will provide an error with details.

For reference, we list here currently required configuration for various bank groups. *Important: You only need to provide information that relates to bank profiles you want to use.*
For reference, we list here currently required configuration for supported bank groups.

Please contact us if you need any assistance populating these configuration values.

```bash
# Bank group: NatWest (only affects sandbox bank profiles)
# Bank group: NatWest (only required if using sandbox bank profiles)
OpenBankingConnector__BankProfiles__NatWest__RoyalBankOfScotlandSandbox__PaymentInitiationApi__BaseUrl=xx # substitute value
OpenBankingConnector__BankProfiles__NatWest__RoyalBankOfScotlandSandbox__IssuerUrl=xx # substitute value
OpenBankingConnector__BankProfiles__NatWest__RoyalBankOfScotlandSandbox__AccountAndTransactionApi__BaseUrl=xx # substitute value
OpenBankingConnector__BankProfiles__NatWest__NatWestSandbox__PaymentInitiationApi__BaseUrl=xx # substitute value
OpenBankingConnector__BankProfiles__NatWest__NatWestSandbox__IssuerUrl=xx # substitute value
OpenBankingConnector__BankProfiles__NatWest__NatWestSandbox__AccountAndTransactionApi__BaseUrl=xx # substitute value

# Bank group: Monzo (only affects sandbox bank profiles)
# Bank group: Monzo (only required if using sandbox bank profiles)
OpenBankingConnector__BankProfiles__Monzo__Monzo__PaymentInitiationApi__ApiVersion=VersionZZ # substitute value
OpenBankingConnector__BankProfiles__Monzo__Monzo__FinancialId=yy # substitute value

Expand Down
Loading

0 comments on commit cd2e451

Please sign in to comment.