Beneficiaries v2.0.0

Owned by Chris Michael (Unlicensed)
Last updated: Feb 27, 2018
6 min read

Version Control

VersionDateAuthorComments
2.0-rc2Open Banking Read/Write API Team

This is the first Release Candidate with Split from One Page Specification.

  • Modified usage examples:
    • Removed references to x-jws-signature
    • Updated link URLs
    • Name-spaced AccountRequestIds in usage examples - as IntentIds are name-spaced in other usage examples. ASPSPs may construct the IntentId as they wish.
  • Additional guidance for ReadBeneficiariesDetail permission
2.0-rc3 Open Banking Read/Write API Team

This is the initial version for release candidate 3

Updates:

  • Updated mandatory, conditional or optional as per Design Principles
2.0.0Open Banking Read/Write API TeamThis is the baseline version. No changes from v2.0-rc3.

Endpoints

Endpoints for the resource - and available methods.


ResourceHTTP OperationEndpointMandatory?ScopeGrant TypeIdempotentParametersRequest ObjectResponse Object
1beneficiariesGETGET /accounts/{AccountId}/beneficiariesConditionalaccountsAuthorization Code


OBReadBeneficiary2
2beneficiaries


GET

GET /beneficiaries

OptionalaccountsAuthorization Code
Pagination
OBReadBeneficiary2
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).

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.

Data Model

The OBReadBeneficiary1 object will be used for the call to: 

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

Resource Definition

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:

  • If a PSU selects multiple accounts for authorisation - then their beneficiaries apply consistently to all selected accounts (i.e., in the bulk endpoint /beneficiaries)
  • If a different PSU selects the same accounts - a different set of beneficiaries could be returned

This is the expected behaviour of the beneficiaries endpoints - in the case an ASPSP manages beneficiaries at a customer level:

  • The bulk endpoint /beneficiaries will return the unique list of beneficiaries against the PSU. In this case - the AccountId in the OBReadBeneficiary1 payload would be set to NULL / empty (even if the PSU 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 PSU. In this case - the AccountId will be populated in the payload

UML Diagram

Notes:

  • The CreditorAccount is used consistently throughout the Account Information APIs to identify an account
  • Due to internationalisation requirements:
    • The CreditorAgent object may be used to represent either (1) the BIC (with BICFI in the SchemeName field and the BIC in the Identification field), or (2) the Name and Address details for the financial instiution
    • The CreditorAccount/Identification field may be used to represent a non-UK specific branch and account numbering scheme with "SortCodeAccountNumber" being populated in the CreditorAccount/SchemeName
  • 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).

Permission Codes

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.

  • These objects must not be returned without the ReadBeneficiariesDetail permission:
    • OBReadBeneficiary2/Data/Beneficiary/CreditorAgent
    • OBReadBeneficiary2/Data/Beneficiary/CreditorAccount
  • If the ReadBeneficiariesDetail is granted by the PSU:
    • OBReadBeneficiary2/Data/Beneficiary/CreditorAgent may be returned if applicable to the account and ASPSP (0..1)
    • OBReadBeneficiary2/Data/Beneficiary/CreditorAccount must be returned (1..1)

Data Dictionary

NameOccurrenceXPathEnhancedDefinitionClassCodes
OBReadBeneficiary2
OBReadBeneficiary2
OBReadBeneficiary2
Data1..1OBReadBeneficiary2/Data
OBReadDataBeneficiary2
Beneficiary0..nOBReadBeneficiary2/Data/Beneficiary
OBBeneficiary2
AccountId0..1OBReadBeneficiary2/Data/Beneficiary/AccountIdA unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.Max40Text
BeneficiaryId0..1OBReadBeneficiary2/Data/Beneficiary/BeneficiaryIdA unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.Max40Text
Reference0..1OBReadBeneficiary2/Data/Beneficiary/ReferenceUnique 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
CreditorAgent0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgentParty 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
SchemeName0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/SchemeNameName of the identification scheme, in a coded form as published in an external list.OBExternalFinancialInstitutionIdentification2CodeBICFI
Identification0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/IdentificationUnique and unambiguous identification of the servicing institution.Max35Text
Name0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/NameName by which an agent is known and which is usually used to identify that agent.Max140Text
PostalAddress0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddressInformation that locates and identifies a specific address, as defined by postal services.OBPostalAddress6
AddressType0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/AddressTypeIdentifies the nature of the postal address.OBAddressTypeCode

Business
Correspondence

DeliverTo

MailTo

POBox

Postal

Residential

Statement

Department0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/DepartmentIdentification of a division of a large organisation or building.Max70Text
SubDepartment0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/SubDepartmentIdentification of a sub-division of a large organisation or building.Max70Text
StreetName0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/StreetNameName of a street or thoroughfare.Max70Text
BuildingNumber0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/BuildingNumberNumber that identifies the position of a building on a street.Max16Text
PostCode0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/PostCodeIdentifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.Max16Text
TownName0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/TownNameName of a built-up area, with defined boundaries, and a local government.Max35Text
CountrySubDivision0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/CountrySubDivisionIdentifies a subdivision of a country such as state, region, county.Max35Text
Country0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/CountryNation with its own government.CountryCode
AddressLine0..7OBReadBeneficiary2/Data/Beneficiary/CreditorAgent/PostalAddress/AddressLineInformation that locates and identifies a specific address, as defined by postal services, presented in free format text.Max70Text
CreditorAccount0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAccountProvides the details to identify the beneficiary account.OBCashAccount1
SchemeName1..1OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/SchemeNameName of the identification scheme, in a coded form as published in an external list.OBExternalAccountIdentification2CodeIBAN
SortCodeAccountNumber
Identification1..1OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/IdentificationIdentification assigned by an institution to identify an account. This identification is known by the account owner.Max34Text
Name0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/NameName 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
SecondaryIdentification0..1OBReadBeneficiary2/Data/Beneficiary/CreditorAccount/SecondaryIdentificationThis 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

Usage Examples

Specific Account

Request

Get Account Beneficiaries 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

Get Account Beneficiaries 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"
        }
      }
    ]
  },
  "Links": {
    "Self": "https://api.alphabank.com/open-banking/v2.0/accounts/22289/beneficiaries/"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Bulk

Request

Get Beneficiaries 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

Get Beneficiaries 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
  }
}

© Open Banking Limited 2019 | https://www.openbanking.org.uk/open-licence | https://www.openbanking.org.uk