Open Banking UK
HomeStatus
  • Introduction
  • API reference
    • Account access consents
    • Accounts
      • Balances
      • Beneficiaries
      • Transactions
    • Download Specification
  • Support
  • Return Home
Powered by GitBook
On this page
  1. API reference
  2. Accounts

Beneficiaries

PreviousBalancesNextTransactions

Last updated 2 years ago

Get Beneficiaries

get
Authorizations
Path parameters
AccountIdanyRequired

AccountId

Header parameters
x-fapi-financial-idanyRequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timeanyOptional

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressanyOptional

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idanyOptional

An RFC4122 UID used as a correlation id.

AuthorizationanyOptional

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 - required for API calls but may be ommited when using Swagger UI where the "Authorize" function has been operated

x-customer-user-agentanyOptional

Indicates the user-agent that the PSU is using.

Responses
200
Beneficiaries Read
400
Bad request
401
Unauthorized
403
Forbidden
404
Not found
405
Method Not Allowed
406
Not Acceptable
429
Too Many Requests
500
Internal Server Error
get
GET /algbra/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries HTTP/1.1
Host: secure.tell.systems
x-fapi-financial-id: null
Accept: */*

No content