...
The accounts resource is used by an AISP to retrieve full list of accounts and account information that the PSU customer has authorised to access.
...
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object |
2.1 | accounts | GET | GET /accounts | Mandatory | accounts | Authorization Authorisation Code | No | Pagination |
| OBReadAccount |
2.2 | accounts | GET | GET/accounts /{accountsIdAccountId} | Mandatory | accounts | Authorization Authorisation Code | No |
|
| OBReadAccount |
2.1. GET/accounts
...
An AISP will be given the full list of accounts (the AccountId(s)) that the PSU customer 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.
...
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 Bahrain identification schemes:
Account/Account
Where " BH.OBF.IBAN" is specified as the SchemeName, the Identification field must be populated with the full IBAN.
Account/Servicer
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.
Where " BH.OBF.IBAN" is populated as the SchemeName, the Identification field must be populated with the BIC.
...
[GG1]@Dinesh to confirm
3.4. Permission Codes
...
Name | Occurrence | XPath | Enhanced Definition | Class | Codes | Pattern | |||||||
OBReadAccount |
| OBReadAccount |
| OBReadAccount |
|
| |||||||
Data | 1..1 | OBReadAccount/Data |
| OBReadAccount/Data |
|
| |||||||
Account | 0..n | OBReadAccount/Data/Account | Unambiguous identification of the account to which credit and debit entries are made. | OBReadAccount/Data/Account |
|
| |||||||
AccountId | 1..1 | OBReadAccount/Data/Account/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | String |
|
| |||||||
Status | 0..1 | OBReadAccount/Data/Account/Status | Specifies the status of account resource in code form. | String | Enum:
|
| |||||||
StatusUpdateDateTime | 0..1 | OBReadAccount/Data/Account/StatusUpdateDateTime | Date and time at which the resource status was updated. | DateTime |
|
| |||||||
Currency | 1..1 | OBReadAccount/Data/Account/Currency | Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account. | String |
| ^[A-Z]{3,3}$ | |||||||
AccountType | 1..1 | OBReadAccount/Data/Account/AccountType | Specifies the type of account (personal or business). | String | Enum:
|
| |||||||
AccountSubType | 1..1 | OBReadAccount/Data/Account/AccountSubType | Specifies the sub type of account (product family group). | String | Enum:
|
| |||||||
Description | 0..1 | OBReadAccount/Data/Account/Description | Specifies the description of the account type. | String |
|
| |||||||
Nickname | 0..1 | OBReadAccount/Data/Account/Nickname | The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account. | String |
|
| |||||||
OpeningDate | 0..1 | OBReadAccount/Data/Account/OpeningDate | Date on which the account and related basic services are effectively operational for the account owner. | DateTime |
|
| |||||||
MaturityDate | 0..1 | OBReadAccount/Data/Account/MaturityDate | Maturity date for the account. | DateTime |
|
| |||||||
Account | 0..n | OBReadAccount/Data/Account/Account | Provides the details to identify an account. | OBReadAccount/Data/Account/Account |
|
| |||||||
SchemeName | 1..1 | OBReadAccount/Data/Account/Account/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalAccountIdentificationCode | Enum:
|
| |||||||
Identification | 1..1 | OBReadAccount/Data/Account/Account/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | String |
|
| |||||||
Name | 0..1 | OBReadAccount/Data/Account/Account/Name | The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. | String |
|
| SecondaryIdentification | 0..1 | OBReadAccount/Data/Account/Account/SecondaryIdentification | This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). | String |
|
|
Servicer | 0..1 | OBReadAccount/Data/Account/Servicer | Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. | OBReadAccount/Data/Account/Servicer |
|
| |||||||
SchemeName | 1..1 | OBReadAccount/Data/Account/Servicer/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | String | Enum:
|
| |||||||
Identification | 1..1 | OBReadAccount/Data/Account/Servicer/Identification | Unique and unambiguous identification of the servicing institution. | String |
|
|
...
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 00348765 has a building society roll number; and AccountId 00345897 does not.
4.1.1 Request
|
...
|
4.2. Specific Account
...
4.2.1 Request
|
...
|
|