Version Control

Endpoints

An AISP will be given the full list of accounts (the AccountId(s)) that the PSU has authorised the AISP to access. The AccountId(s) returned may then be used to retrieve other resources for a specific AccountId. The selection of authorised accounts happens only at the ASPSP's interface.

GET /accounts/{AccountId}

An AISP may retrieve the account information resources for the AccountId (which is retrieved in the call to GET /accounts).

Data Model

The OBReadAccount2 object will be used for the call to:

• GET /accounts/{AccountId}
• GET /accounts

Resource Definition

This resource represents the account to which credit and debit entries are made.

Each account resource will have a unique and immutable AccountId.

UML Diagram

Notes:

• The Account and Servicer structure has been designed to:
  • Reflect the DebtorAccount and DebtorAgent (and similarly for CreditorAccount and CreditorAgent) structures in the PISP use case
  • Having a SchemeName for the Account and Servicer blocks means we can be flexible to accommodate multiple types of accounts
• For common Domestic UK identification schemes:
  • Account/Account
    • Where "SortCodeAccountNumber" is specified as the SchemeName, the Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field)
    • Where "IBAN" is specified as the SchemeName, the Identification field must be populated with the full IBAN
    • Where "PAN" is specified as the SchemeName, the Identification field must be populated with the primary PAN linked to the account. An ASPSP may choose to mask digits returned in the Identification field.
  • Account/Servicer
    • Where "BICFI" is populated as the SchemeName, the Identification field must be populated with the BIC 
• The SecondaryIdentification field is used to identify an account in addition to the primary Account/Identification field. SecondaryIdentification may be populated with a roll number for building societies, or a currency code where an account has multiple currency sub-accounts.

Permission Codes

The resource differs depending on the permissions (ReadAccountsBasic and ReadAccountsDetail) used to access resource. In the event the resource is accessed with both ReadAccountsBasic and ReadAccountsDetail, the most detailed level (ReadAccountsDetail) must be used.

• These objects must not be returned without the ReadAccountsDetail permission:
  • OBReadAccount2/Data/Account/Account
  • OBReadAccount2/Data/Account/Servicer
• If the ReadAccountsDetail is granted by the PSU:
  • OBReadAccount2/Data/Account/Account must be returned (1..n)
  • OBReadAccount2/Data/Account/Servicer may be returned if applicable to the account and ASPSP (0..1)

If the ReadPAN permission is granted by the PSU - the ASPSP may choose to populate the OBReadAccount2/Data/Account/Account/Identification with the unmasked PAN (if the PAN is being populated in the response).

Data Dictionary

Usage Examples

Bulk - Detail Permission

The call to GET /accounts is the first step after an account-request is authorised. This will allow the AISP to discover which accounts (and AccountId values) are associated with the authorisation of consent.

In this scenario AccountId 22289 has a building society roll number; and AccountId 31820 does not.

The ReadAccountsDetail permission has been granted.

Specific Account - Detail Permission

An AISP may also retrieve the account resource details specifically for AccountId 22289.

The ReadAccountsDetail permission has been granted.

Bulk - Basic Permission

The ReadAccountsBasic permission has been granted.