|
Version | Date | Author | Comments |
---|---|---|---|
2.0-rc2 | Open Banking Read/Write API Team | This is the first Release Candidate with Split from One Page Specification.
| |
2.0-rc3 | Open Banking Read/Write API Team | This is the initial version for release candidate 3 Updates:
| |
2.0.0 | Open Banking Read/Write API Team | This is the baseline version. No changes from v2.0-rc3. |
Endpoints for the resource - and available methods.
Resource | HTTP Operation | Endpoint | Mandatory? | Scope | Grant Type | Idempotent | Parameters | Request Object | Response Object | |
---|---|---|---|---|---|---|---|---|---|---|
1 | beneficiaries | GET | GET /accounts/{AccountId}/beneficiaries | Conditional | accounts | Authorization Code | OBReadBeneficiary2 | |||
2 | beneficiaries | GET | GET /beneficiaries | Optional | accounts | Authorization Code | Pagination | OBReadBeneficiary2 |
An AISP may retrieve the account beneficiaries information resource for a specific AccountId (which is retrieved in the call to GET /accounts).
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.
The OBReadBeneficiary1 object will be used for the call to:
A resource that contains a set of elements that describes the list of trusted beneficiaries linked to a specific account (AccountId).
An account (AccountId) may have no trusted beneficiaries set up, or may have multiple beneficiaries set up.
In the case an ASPSP manages beneficiaries at a customer level (logged in user), instead of account level:
This is the expected behaviour of the beneficiaries endpoints - in the case an ASPSP manages beneficiaries at a customer level:
Notes:
The resource differs depending on the permissions (ReadBeneficiariesBasic and ReadBeneficiariesDetail) used to access resource. In the event the resource is accessed with both ReadBeneficiariesBasic and ReadBeneficiariesDetail, the most detailed level (ReadBeneficiariesDetail) must be used.
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes |
---|---|---|---|---|---|
OBReadBeneficiary2 | OBReadBeneficiary2 | OBReadBeneficiary2 | |||
Data | 1..1 | OBReadBeneficiary2/Data | OBReadDataBeneficiary2 | ||
Beneficiary | 0..n | OBReadBeneficiary2/Data/Beneficiary | OBBeneficiary2 | ||
AccountId | 0..1 | OBReadBeneficiary2/Data/Beneficiary/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | Max40Text | |
BeneficiaryId | 0..1 | OBReadBeneficiary2/Data/Beneficiary/BeneficiaryId | A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. | Max40Text | |
Reference | 0..1 | OBReadBeneficiary2/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. | Max35Text | |
CreditorAgent | 0..1 | OBReadBeneficiary2/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. | OBBranchAndFinancialInstitutionIdentification3 | |
SchemeName | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalFinancialInstitutionIdentification2Code | BICFI |
Identification | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/Identification | Unique and unambiguous identification of the servicing institution. | Max35Text | |
Name | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/Name | Name by which an agent is known and which is usually used to identify that agent. | Max140Text | |
PostalAddress | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress | Information that locates and identifies a specific address, as defined by postal services. | OBPostalAddress6 | |
AddressType | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/AddressType | Identifies the nature of the postal address. | OBAddressTypeCode | Business DeliverTo MailTo POBox Postal Residential Statement |
Department | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/Department | Identification of a division of a large organisation or building. | Max70Text | |
SubDepartment | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/SubDepartment | Identification of a sub-division of a large organisation or building. | Max70Text | |
StreetName | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/StreetName | Name of a street or thoroughfare. | Max70Text | |
BuildingNumber | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/BuildingNumber | Number that identifies the position of a building on a street. | Max16Text | |
PostCode | 0..1 | OBReadBeneficiary2/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. | Max16Text | |
TownName | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/TownName | Name of a built-up area, with defined boundaries, and a local government. | Max35Text | |
CountrySubDivision | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/CountrySubDivision | Identifies a subdivision of a country such as state, region, county. | Max35Text | |
Country | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/Country | Nation with its own government. | CountryCode | |
AddressLine | 0..7 | OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/AddressLine | Information that locates and identifies a specific address, as defined by postal services, presented in free format text. | Max70Text | |
CreditorAccount | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAccount | Provides the details to identify the beneficiary account. | OBCashAccount1 | |
SchemeName | 1..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/SchemeName | Name of the identification scheme, in a coded form as published in an external list. | OBExternalAccountIdentification2Code | IBAN SortCodeAccountNumber |
Identification | 1..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/Identification | Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max34Text | |
Name | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/Name | Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. Usage: The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number. | Max70Text | |
SecondaryIdentification | 0..1 | OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/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). | Max34Text |
Request
GET /accounts/22289/beneficiaries HTTP/1.1 Authorization: Bearer Az90SAOJklae x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json |
Request
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "Beneficiary": [ { "AccountId": "22289", "BeneficiaryId": "Ben1", "Reference": "Towbar Club", "CreditorAccount": { "SchemeName": "SortCodeAccountNumber", "Identification": "80200112345678", "Name": "Mrs Juniper" } } ] }, "Links": { "Self": "https://api.alphabank.com/open-banking/v2.0/accounts/22289/beneficiaries/" }, "Meta": { "TotalPages": 1 } } |
Request
GET /beneficiaries HTTP/1.1 Authorization: Bearer Az90SAOJklae x-fapi-financial-id: OB/2017/001 x-fapi-customer-last-logged-time: Sun, 10 Sep 2017 19:43:31 UTC x-fapi-customer-ip-address: 104.25.212.99 x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json |
Response
HTTP/1.1 200 OK x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Content-Type: application/json { "Data": { "Beneficiary": [ { "AccountId": "22289", "BeneficiaryId": "Ben1", "Reference": "Towbar Club", "CreditorAccount": { "SchemeName": "SortCodeAccountNumber", "Identification": "80200112345678", "Name": "Mrs Juniper" } }, { "AccountId": "31820", "BeneficiaryId": "Ben37", "Reference": "Golf Club", "CreditorAccount": { "SchemeName": "SortCodeAccountNumber", "Identification": "87562298675421", "Name": "Mr Large" } } ] }, "Links": { "Self": "https://api.alphabank.com/open-banking/v2.0/beneficiaries/" }, "Meta": { "TotalPages": 1 } } |