Implementation Guide: Hargreaves Lansdown

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.


ASPSPHARGREAVES LANSDOWN SAVINGS LIMITED
BrandHL Savings
Date  
Developer portal (s)https://www.hl.co.uk/about-us/developer-tools

Announcements

Improvement
Delivery date

Implementation of Sandbox

14/03/2019




Change to Production:

Improvement
Delivery date
Initial delivery of Production services  





On-boarding

Supports dynamic client registration (Y/N)Yes
Instructions for manual onboardingManual onboarding is not supported
OIDC .well-known endpoint

https://matls.rs.aspsp.api-hls.hl.co.uk/auth/oauth2/.well-known/openid-configuration

Notes on testing

TPPs must be registered with the Open Banking Sandbox Directory in order to use the HL Savings Sandbox environment.

Separate onboarding/registration via the dynamic client registration endpoint is required.

.well-known endpoint: https://matls.rs.aspsp.sandbox-hls.hl.co.uk/auth/oauth2/.well-known/openid-configuration

Other on-boarding notes

N/A

Documentation URL


https://www.hl.co.uk/about-us/developer-tools

Account Information API

Note to ASPSP: Please add a column per brand if relevant

RefAreaFieldAvailable (Y/N)Exception/Notes (inc details on classification codes, field limits, and field formats)

Endpoint 1

POST /account-access-consents

-

Y

Mandatory

Endpoint 2

GET /account-access-consents/{AccountRequestId}

-

Y

Mandatory

Endpoint 3

DELETE /account-access-consents/{AccountRequestId}

-

Y

Mandatory

Endpoint 4

GET /accounts

-

Y

Mandatory

In the main Account Data node, the nickname element will not be provided.

The Account and Servicer nodes will not be populated.

N.B. Only the ReadAccountBasic permission is provided due to the structure of the Active Savings Product. 

Endpoint 5

GET /accounts/{AccountId}

-

Y

Mandatory

In the main Account Data node, the nickname element will not be provided.

The Account and Servicer nodes will not be populated.

Endpoint 6

GET /accounts/{AccountId}/balances

-

Y

Mandatory

The CreditLine node will not be provided.

Endpoint 7

GET /accounts/{AccountId}/transactions

-

Y

Mandatory

In the main Transaction node, the TransactionReference, StatementReferences, TransactionInformation and Address elements will not be provided.

The following nodes will not be provided as they have no context on the Active Savings account:

·       ChargeAmount - there are no transaction-level charges on the Active Savings account

·       CurrencyExchange - all transactions on the Active Savings account are in GBP

·       BankTransactionCode - not relevant to the Active Savings account

·       ProprietaryBankTransactionCode - not relevant to the Active Savings account

·       MerchantDetails - not relevant

·       CreditorAgent - not relevant

·       DebtorAgent - not relevant

·       CardInstrument - not relevant

In the CreditorAccount and DebtorAccount nodes, only the Name element will be provided.

Endpoint 8

GET /accounts/{AccountId}/beneficiaries

-

N

Conditional

Not being offered - no concept for Active Savings accounts.

Endpoint 9

GET /accounts/{AccountId}/direct-debits

-

N

Conditional

Not being offered - no concept for Active Savings accounts.

Endpoint 10

GET /accounts/{AccountId}/standing-orders

-

N

Conditional

Not being offered - no concept for Active Savings accounts.

Endpoint 11

GET /accounts/{AccountId}/product

-

Y

Conditional

In the main Product node, the SecondaryProductId and MarketingStateId elements will not be provided.

As the Active Savings account falls under the Product Type of "Other", the OtherProductType node will be included. The BCA and PCA nodes will not be provided as they are not relevant to the Active Savings account.

Endpoint 12

GET /accounts/{AccountId}/offers

-

N

Conditional

Not being offered - no concept for Active Savings accounts.

Endpoint 13

GET /accounts/{AccountId}/party

-

N

Not offered

Endpoint 14

GET /accounts/{AccountId}/scheduled-payments

-

N

Conditional

Not being offered - no concept for Active Savings accounts.

Endpoint 15

GET /accounts/{AccountId}/statements

-

N

Optional

Not being offered

Endpoint 16

GET /accounts/{AccountId}/statements/{StatementId}

-

N

Optional

Not being offered

Endpoint 17

GET /accounts/{AccountId}/statements/{StatementId}/file

-

N

Optional

Not being offered

Endpoint 18

GET /accounts/{AccountId}/statements/{StatementId}/transactions

-

Y

Conditional

In the main Transaction node, the TransactionReference, StatementReferences, TransactionInformation and Address elements will not be provided.

The following nodes will not be provided as they have no context on the Active Savings account:

·       ChargeAmount - there are no transaction-level charges on the Active Savings product

·       CurrencyExchange - all transactions on the Active Savings product are in GBP

·       BankTransactionCode - not relevant to the Active Savings product

·       ProprietaryBankTransactionCode - not relevant to the Active Savings product

·       MerchantDetails - not relevant

·       CreditorAgent - not relevant

·       DebtorAgent - not relevant

·       CardInstrument - not relevant

In the CreditorAccount and DebtorAccount nodes, only the Name element will be provided.

Endpoint 19

GET /balances

-

N

Optional

Not being offered.

Endpoint 20

GET /transactions

-

N

Optional

Not being offered.

Endpoint 21

GET /beneficiaries

-

N

Optional

Not being offered - no concept for Active Savings accounts.

Endpoint 22

GET /direct-debits

-

N

Optional

Not being offered - no concept for Active Savings accounts.

Endpoint 23

GET /standing-orders

-

N

Optional

Not being offered - no concept for Active Savings accounts.

Endpoint 24

GET /products

-

N

Optional

Not being offered.

Endpoint 25

GET /offers

-

N

Optional

Not being offered - no concept for Active Savings accounts.

Endpoint 26

GET /party

-

N

Optional

Not being offered.

Endpoint 27

GET /scheduled-payments

-

N

Optional

Not being offered - no concept for Active Savings accounts.

Endpoint 28

GET /statements

-

N

Optional

Not being offered.


Payment Initiation API

Swagger versionN/A
Base URIN/A
General variances to specificationN/A
Non-functional limitationsN/A
RefAreaFieldAvailable (Y/N)Exception/Notes (inc details on classification codes, field limits, and field formats)















Open Data API

Swagger versionN/A
Base URIN/A
General variances to specification N/A
Non-functional limitationsN/A
RefAreaFieldAvailable (Y/N)Exception/Notes (inc details on classification codes, field limits, and field formats)