Implementation Guide: Coutts & Company
This page has been created and maintained by the relevant ASPSP, and OBIE takes no liability for the completeness nor accuracy of this data.
Note to ASPSP: Please indicate which brands this applies to and/or duplicate this page per brand if relevant.
Announcements:
TPP Info
Planned Improvements | Delivery date |
|---|---|
App-to-App enhancements: Coutts & Co plans to implement app-to-app enhancements for Open Banking journeys by mid November. | 17.11.2019 |
File Payments v3.1 | 17.11.2019 |
Change to Production:
Improvement | Delivery date |
|---|---|
n/a | - |
On-boarding
Supports dynamic client registration (Y/N) | Y |
|---|---|
Instructions for manual onboarding | Coutts & Co. does not support manual registration. Only dynamic registration is supported. |
OIDC .well-known endpoint | |
Notes on testing | Follow the instructions on the ‘Sandbox’ page in our developer portal to get started. For all other testing related support queries, raise a testing related request using the service desk on our developer portal ‘Launch the Service Desk’ page. Until September 14th, Coutts & Co. is in a phase of live proving with a limited number of customers. If a TPP should plan to integrate with Coutts productively and test the APIs, then please contact us via the service desk mentioned above. |
Other on-boarding notes | Currently, Coutts & Co. supports certificates issued by Open Banking. Support of eIDAS certificates is planned to be available by end of November 2019. |
Documentation URL | https://www.bankofapis.com/products/accounts/documentation/coutts/3.0.0 |
FAPI Compliance
Coutts & Co. has successfully passed the FAPI conformance requirements without any warnings.
Link: https://openid.net/certification/#FAPI_OPs
Account Information API
Swagger version | 3.1 |
|---|---|
Base URI | |
General variances to specification | Bulk endpoints not implemented |
Non-functional limitations | Global as well as individual TPP rate limiting will be applied for API calls in production and in sandbox. |
List of endpoints
| Resource | Endpoint | Available (Y/N) | Mandatory? |
|---|---|---|---|---|
1 | account-access-consents | POST /account-access-consents | Y | Mandatory |
2 | account-access-consents | GET /account-requests/{AccountRequestId} | Y | Mandatory |
3 | account-access-consents | DELETE /account-requests/{AccountRequestId} | Y | Mandatory |
4 | accounts | GET /accounts | Y | Mandatory |
5 | accounts | GET /accounts/{AccountId} | Y | Mandatory |
6 | balances | GET /accounts/{AccountId}/balances | Y | Mandatory |
7 | balances | GET /balances | N | Optional |
8 | transactions | GET /accounts/{AccountId}/transactions | Y | Mandatory |
9 | transactions | GET /transactions | N | Optional |
10 | beneficiaries | GET /accounts/{AccountId}/beneficiaries | Y | Conditional |
11 | beneficiaries | GET /beneficiaries | N | Optional |
12 | direct-debits | GET /accounts/{AccountId}/direct-debits | Y | Conditional |
13 | direct-debits | GET /direct-debits | N | Optional |
14 | standing-orders | GET /accounts/{AccountId}/standing-orders | Y | Conditional |
15 | standing-orders | GET /standing-orders | N | Optional |
16 | products | GET /accounts/{AccountId}/product | Y | Conditional |
17 | products | GET /products | N | Optional |
18 | offers | GET /accounts/{AccountId}/offers | N | Conditional |
19 | offers | GET /offers | N | Optional |
20 | party | GET /accounts/{AccountId}/party | N | Conditional |
21 | party | GET /party | N | Optional |
22 | scheduled-payments | GET /accounts/{AccountId}/scheduled-payments | Y | Conditional |
23 | scheduled-payments | GET /scheduled-payments | N | Optional |
24 | statements | GET /accounts/{AccountId}/statements | N | Conditional |
25 | statements | GET /accounts/{AccountId}/statements/{StatementId} | N | Conditional |
26 | statements | GET /accounts/{AccountId}/statements/{StatementId}/file | N | Optional |
27 | transactions | GET /accounts/{AccountId}/statements/{StatementId}/transactions | N | Conditional |
28 | statements | GET /statements | N | Conditional |
Fields information
The information struck through are not valid for the current implementation, see the red text for the implementation differences/details.
Account Access Consents - Request - Data Dictionary
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes |
|---|---|---|---|---|---|
OBReadConsent1 |
| OBReadConsent1 |
| OBReadConsent1 |
|
Data | 1..1 | OBReadConsent1/Data |
| OBReadData1 |
|
Permissions | 1..n | OBReadConsent1/Data/Permissions | Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. | OBExternalPermissions1Code | ReadAccountsBasic |
ExpirationDateTime | 0..1 | OBReadConsent1/Data/ExpirationDateTime | Specified date and time the permissions will expire. | ISODateTime |
|
TransactionFromDateTime | 0..1 | OBReadConsent1/Data/TransactionFromDateTime | Specified start date and time for the transaction query period. | ISODateTime |
|
TransactionToDateTime | 0..1 | OBReadConsent1/Data/TransactionToDateTime | Specified end date and time for the transaction query period. | ISODateTime |
|
Risk | 1..1 | OBReadConsent1/Risk | The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. | OBRisk2 |
|
Account Access Consents - Response - Data Dictionary
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes |
|---|---|---|---|---|---|
OBReadConsentResponse1 | OBReadConsentResponse1 | OBReadConsentResponse1 |
|
|
|
Data | 1..1 | OBReadConsentResponse1/Data | OBReadDataConsentResponse1 |
|
|
ConsentId | 1..1 | OBReadConsentResponse1/Data/ConsentId | Unique identification as assigned to identify the account access consent resource. | Max128Text |
|
CreationDateTime | 1..1 | OBReadConsentResponse1/Data/CreationDateTime | Date and time at which the resource was created. | ISODateTime |
|
Status | 1..1 | OBReadConsentResponse1/Data/Status | Specifies the status of consent resource in code form. | OBExternalRequestStatus1Code | Authorised |
StatusUpdateDateTime | 1..1 | OBReadConsentResponse1/Data/StatusUpdateDateTime | Date and time at which the resource status was updated. | ISODateTime |
|
Permissions | 1..n | OBReadConsentResponse1/Data/Permissions | Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. | OBExternalPermissions1Code | ReadAccountsBasic |