Open Banking API
Retrieve all account's beneficiaries
api
get
/accounts/{AccountId}/beneficiaries

Retrieve all account's beneficiaries

Get all the beneficiaries of a specific user account.

Upcoming changes

To comply with PSD2 SCA regulations, from 18 November 2024, we will only allow access to this endpoint within the first 5 minutes after the user has authorised the consent. After those 5 minutes, access to this endpoint will be denied and an HTTP 403 error will be returned.

See also Tutorials: Get account and transaction information.

Authorization​

Each Open Banking API must contain an authorization header in the following format to make a call: Bearer <yourAccessToken>.

Before you start, ensure that you've got an access token with the correct scope using the /token endpoint. You need to get the authorization code first and exchange it for an access token.

danger

Never share your access_token with anyone, as it can be used to access the banking data that you have access to and initiate transactions.

For more information, see Tutorial: Get account and transaction information and Tutorial: Initiate your first payment as examples.

x-jws-signature​

Open Banking API Payment requests additionally require a JSON Web Signature (JWS) which needs to be added to the header of the request. The JWS signature must be obtained using the full content of the payload.

Request​

Path Parameters
Path Parameters

The ID of the account.

Header Parameters
Header Parameters

The unique ID of the ASPSP that the request is issued to. The ID of Revolut is 001580000103UAvAAM.

Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

The date and time when the PSU last logged in with the TPP.

All dates in the HTTP headers are represented as RFC 7231 Full Dates. For example: Sun, 10 Sep 2017 19:43:31 UTC.

The IP address of the PSU if the PSU is logged in with the TPP.

An RFC4122 UUID used as a correlation ID.

The access token that you've generated. For more information, see Generate an access token.

The user agent that the PSU is using.

Response​

Beneficiaries Read

HTTP Headers
HTTP Headers

An RFC4122 UUID used as a correlation ID.

Response body
Body object

A list of beneficiaries.

Possible values: non-empty and <= 40 characters

The unique and immutable ID to identify the account resource. This ID has no meaning to the account owner.

Possible values: non-empty and <= 40 characters

The unique and immutable ID to identify the beneficiary resource. This ID has no meaning to the account owner.

The details to identify the account.

Possible values: [UK.OBIE.IBAN, UK.OBIE.SortCodeAccountNumber, US.RoutingNumberAccountNumber, US.BranchCodeAccountNumber, UK.Revolut.InternalAccountId]

The name of the identification scheme.

Note the scheme UK.Revolut.InternalAccountId is an internal account identifier for those accounts which don't have externally available identifiers. It cannot be used to send or receive funds.

Possible values: non-empty and <= 256 characters

The identification of the account.

Possible values: non-empty and <= 70 characters

The account name that the account servicing institution assigns.

The account name is the name or names of the account owner(s) represented at an account level.

The account name is not the product name or the nickname of the account.

Possible values: non-empty and <= 34 characters

The secondary account ID that the account servicing institution assigns.

Building societies can use this ID to identify accounts with a roll number in addition to a sort code and account number combination.

Links relevant to the payload.

The absolute URI to the resource.

The absolute URI to the next pagination resource.

The absolute URI to the previous pagination resource.

Meta data relevant to the payload.

Used for pagination. Indicates how many pages of results are available.

Was this page helpful?
Loading...