Beneficiaries
- CBB Admin
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 28th Oct 2020 | Initial Release |
2. Overview
The beneficiaries resource is used by an AISP to retrieve the account beneficiaries information for a specific AccountId or to retrieve the beneficiaries' information in bulk for account(s) that the user/customer has authorised to access.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
3. Endpoints
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object |
3.1 | beneficiaries | GET | GET /accounts/{AccountId}/beneficiaries | Conditional | accounts | Authorisation Code | No |
|
| OBReadBeneficiary |
3.2 | beneficiaries | GET | GET /beneficiaries | Optional | accounts | Authorisation Code | No | Pagination |
| OBReadBeneficiary |
3.1 GET /accounts/{AccountId}/beneficiaries
An AISP may retrieve the account beneficiaries’ information resource for a specific AccountId (which is retrieved in the call to GET /accounts).
3.2 GET /beneficiaries
If an ASPSP has implemented the bulk retrieval endpoints for beneficiaries, an AISP may optionally retrieve the beneficiaries' information in bulk. This endpoint will retrieve the beneficiaries' resources for all authorised accounts linked to a specific account-request.
4. Data Models
4.1 OBReadBeneficiary
The OBReadBeneficiary object will be used for the call to:
GET /accounts/{AccountId}/beneficiaries
GET /beneficiaries
4.1.1 Resource Definition
A resource that contains a set of elements that describes the list of beneficiaries linked to a specific account (AccountId).
The beneficiaries may be Trusted Beneficiaries as well as other types of beneficiaries as indicated by the BeneficiaryType property.
An account (AccountId) may have no beneficiaries set up, or may have multiple beneficiaries set up.
In the case an ASPSP manages beneficiaries at a user/customer level (logged in user), instead of account level:
If a user/customer selects multiple accounts for authorisation, then their beneficiaries apply consistently to all selected accounts (i.e., in the bulk endpoint /beneficiaries)
This is the expected behaviour of the beneficiaries' endpoints, in the case an ASPSP manages beneficiaries at a user/customer level:
The bulk endpoint /beneficiaries will return the unique list of beneficiaries against the user/customer. In this case, the AccountId in the OBReadBeneficiary payload would be set to NULL / empty (even if the user/customer only has one account)
The selected account endpoint /accounts/{AccountId}/beneficiaries will return the beneficiaries that may be accessible to the AccountId, based on the user/customer. In this case, the AccountId will be populated in the payload
4.1.2 UML Diagram
4.1.3 Notes
The CreditorAccount is used consistently throughout the Account Information APIs to identify an account
For the /accounts/{AccountId}/beneficiaries endpoint, the CreditorAccount and CreditorAgent blocks represent the account of the beneficiary that is receiving funds (so has been named the CreditorAccount for consistency with the PISP use case)
The beneficiaries may be Trusted Beneficiaries as well as other types of beneficiaries as indicated by the BeneficiaryType property. When the BeneficiaryType property is not specified, the consumer should refer to the ASPSP’s developer portal
Due to internationalisation requirements:
The CreditorAgent object may be used to represent either (1) the BIC (with BH.OBF.BICFI in the SchemeName field and the BIC in the Identification field), or (2) the NCC (with BH.OBF.NCC in the SchemeName field and the NCC in the Identification field), or (3) the Name and Address details for the financial institution
The CreditorAccount/Identification field may be used to represent a non-Bahrain specific branch and account numbering scheme
4.1.4 Permission Codes
The resource differs depending on the permissions (ReadBeneficiariesBasic and ReadBeneficiariesDetail) used to access the resource. In the event that the resource is accessed with both ReadBeneficiariesBasic and ReadBeneficiariesDetail, the most detailed level (ReadBeneficiariesDetail) must be used.
These objects must not be returned without the ReadBeneficiariesDetail permission:
OBReadBeneficiary/Data/Beneficiary/CreditorAgent
OBReadBeneficiary/Data/Beneficiary/CreditorAccount
If the ReadBeneficiariesDetail is granted by the user/customer:
OBReadBeneficiary/Data/Beneficiary/CreditorAgent may be returned if applicable to the account and ASPSP (0..1)
OBReadBeneficiary/Data/Beneficiary/CreditorAccount must be returned (1..1)
If the ReadPAN permission is granted by the user/customer, the ASPSP may choose to populate the OBReadBeneficiary/Data/Beneficiary/CreditorAccount/Identification with the unmasked PAN (if the PAN is being populated in the response).
4.1.5 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class/ Datatype | Codes | Pattern |
OBReadBeneficiary |
| OBReadBeneficiary |
| OBReadBeneficiary |
|
|
Data | 1..1 | OBReadBeneficiary/Data |
| OBReadBeneficiary/Data |
|
|
Beneficiary | 0..n | OBReadBeneficiary/Data/Beneficiary |
| OBReadBeneficiary/Data/Beneficiary |
|
|
AccountId | 0..1 | OBReadBeneficiary/Data/Beneficiary/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner | String |
|
|
BeneficiaryId | 0..1 | OBReadBeneficiary/Data/Beneficiary/BeneficiaryId | A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner | String |
|
|
BeneficiaryType | 0..1 | OBReadBeneficiary/Data/Beneficiary/BeneficiaryType | Specifies the Beneficiary Type | String | Enum:
|
|
Reference | 0..1 | OBReadBeneficiary/Data/Beneficiary/Reference | Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification | String |
|
|
SupplementaryData | 0..1 | OBReadBeneficiary/Data/Beneficiary/SupplementaryData | Additional information that cannot be captured in the structured fields and/or any other specific block | OBSupplementaryData |
|
|
CreditorAgent | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent | 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. This is the servicer of the beneficiary account | OBReadBeneficiary/Data/Beneficiary/CreditorAgent |
|
|
SchemeName | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list | String | Enum:
|
|
Identification | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/Identification | Unique and unambiguous identification of the servicing institution | String |
|
|
Name | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/Name | Name by which an agent is known and which is usually used to identify that agent | String |
|
|
PostalAddress | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress |
|
|
AddressType | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/AddressType | Identifies the nature of the postal address | String | Enum:
|
|
Department | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building | String |
|
|
SubDepartment | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building | String |
|
|
AddressLine | 0..7 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text | String |
|
|
StreetName | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/StreetName | Name of a street or thoroughfare | String |
|
|
BuildingNumber | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street | String |
|
|
PostCode | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/PostCode | Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail | String |
|
|
TownName | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government | String |
|
|
CountrySubDivision | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region and country | String |
|
|
Country | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAgent/PostalAddress/Country | Nation with its own government | String |
| ^[A-Z]{2,2}$ |
CreditorAccount | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAccount | Provides the details to identify the beneficiary account | OBReadBeneficiary/Data/Beneficiary/CreditorAccount |
|
|
SchemeName | 1..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list | OBExternalAccountIdentificationCode | Enum:
|
|
Identification | 1..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner | String |
|
|
Name | 0..1 | OBReadBeneficiary/Data/Beneficiary/CreditorAccount/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 |
|
|
5. Usage Example
5.1 Bulk
5.1.1 Get Beneficiaries Request
|
5.1.2 Get Beneficiaries Response
|
|
5.2 Specific Account
5.2.1 Get Account Beneficiaries Request
|
5.2.2 Get Account Beneficiaries Response
|
|
CENTRAL BANK OF BAHRAIN © 2020