API Explorer

v5.1.0 (578 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Get Public Account by Id

Returns information about an account that has a public view.

The account is specified by ACCOUNT_ID. The information is moderated by the view specified by VIEW_ID.

  • Number
  • Owners
  • Type
  • Balance
  • Routing

PSD2 Context: PSD2 requires customers to have access to their account information via third party applications.
This call provides balance and other account information via delegated authentication using OAuth.

Authentication is Optional

URL Parameters:

ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

account_routings:

account_rules:

address:

amount: 10.12

balance: 10

bank_id: gh.29.uk

currency: EUR

display_name:

id: d8839721-ad8f-45dd-9f78-2080414b93f9

label: My Account

number:

owners:

provider: ETHEREUM

scheme: scheme value

type:

value: 5987953

account_attributes:

Typical Successful Response:

								
									
{ "id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0", "bank_id":"gh.29.uk", "label":"My Account", "number":"", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"http://127.0.0.1:8080", "display_name":"OBP" }], "type":"", "balance":{ "currency":"EUR", "amount":"0" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "account_rules":[{ "scheme":"OVERDRAFT", "value":"10" }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getPublicAccountById, operation_id: OBPv3.0.0-getPublicAccountById Tags: Account-Public, Account,

Get Public Accounts at Bank

Returns a list of the public accounts (Anonymous access) at BANK_ID. For each account the API returns the ID and the available views.

Authentication is Optional

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: true

label: My Account

short_name:

views_available:

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by publicAccountsAtOneBank, operation_id: OBPv2.0.0-publicAccountsAtOneBank Tags: Account-Public, Account, PublicData,

Get Public Accounts at all Banks

Get public accounts at all banks (Anonymous access).
Returns accounts that contain at least one public view (a view where is_public is true)
For each account the API returns the ID and the available views.

Authentication is Optional

JSON response body fields:

accounts:

bank_id: gh.29.uk

id: d8839721-ad8f-45dd-9f78-2080414b93f9

is_public: true

label: My Account

short_name:

views_available:

Typical Successful Response:

								
									
{ "accounts":[{ "id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "label":"NoneLabel", "bank_id":"gh.29.uk", "views_available":[{ "id":"1", "short_name":"HHH", "is_public":true }] }] }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30066: Could not get accounts.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by publicAccountsAllBanks, operation_id: OBPv2.0.0-publicAccountsAllBanks Tags: Account-Public, Account, PublicData,