API Explorer

PSD2 APIs v3.1.0 filtered by tag: Account (9)

Bank

Accounts

Views

Counterparties

Transactions

Get Account by Id (Core)

Information returned about the account specified by ACCOUNT_ID:

  • Number - The human readable account number given by the bank that identifies the account.
  • Label - A label given by the owner of the account
  • Owners - Users that own this account
  • Type - The type of account
  • Balance - Currency and Value
  • Account Routings - A list that might include IBAN or national account identifiers
  • Account Rules - A list that might include Overdraft and other bank specific rules

This call returns the owner view and requires access to that view.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "bank_id":"String", "label":"String", "number":"String", "owners":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" }], "type":"String", "balance":{ "currency":"EUR", "amount":"10" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "account_rules":[{ "scheme":"OVERDRAFT", "value":"10" }] }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getCoreAccountById

Get Accounts Held

Get Accounts held by the current User if even the User has not been assigned the owner View yet.

Can be used to onboard the account to the API - since all other account and transaction endpoints require views to be assigned.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "accounts":[{ "id":"12314", "bank_id":"123", "number":"123", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }] }] }
Possible Errors:
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getAccountsHeld

Get Accounts at Bank (IDs only).

Returns only the list of accounts ids at BANK_ID that the user has access to.

Each account must have at least one private View.

For each account the API returns its account ID.

If you want to see more information on the Views, use the Account Detail call.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf" }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getPrivateAccountIdsbyBankId

Get Accounts at Bank (Minimal).

Returns the minimal list of private accounts at BANK_ID that the user has access to. For each account, the API returns the ID, routing addresses and the views available to the current user.

If you want to see more information on the Views, use the Account Detail call.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"String", "bank_id":"gh.29.uk", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "views":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":false }] }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by privateAccountsAtOneBank

Get Accounts at all Banks (private)

Returns the list of accounts containing private views for the user. Each account lists the views available to the user.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "label":"String", "bank_id":"gh.29.uk", "account_type":"330", "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "views":[{ "id":"123", "short_name":"short_name", "description":"description", "is_public":false }] }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by corePrivateAccountsAllBanks

Get Counterparties (Explicit).

Get the Counterparties (Explicit) for the account / view.

Authentication is Mandatory

Typical Successful Response:

								
									
{ "counterparties":[{ "name":"CounterpartyName", "description":"My landlord", "created_by_user_id":"49e1e147-64c1-4823-ad9f-89efcd02a9fa", "this_bank_id":"gh.29.uk", "this_account_id":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "this_view_id":"owner", "counterparty_id":"1d65db7c-a7b2-4839-af41-958276ab7790", "other_bank_routing_scheme":"bankCode", "other_bank_routing_address":"10", "other_branch_routing_scheme":"branchNumber", "other_branch_routing_address":"10010", "other_account_routing_scheme":"accountNumber", "other_account_routing_address":"7987987-2348987-234234", "other_account_secondary_routing_scheme":"accountId", "other_account_secondary_routing_address":"8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0", "is_beneficiary":true, "bespoke":[{ "key":"englishName", "value":"english Name" }] }] }
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Implmented in 2_2_0 by getExplictCounterpartiesForAccount

Get Other Account by Id.

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_ID. Authentication is Optional

Authentication is required if the view is not public.

Typical Successful Response:

								
									
{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "metadata":{ "public_alias":"NONE", "private_alias":"NONE", "more_info":"www.openbankproject.com", "URL":"www.openbankproject.com", "image_URL":"www.openbankproject.com", "open_corporates_URL":"www.openbankproject.com", "corporate_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } } }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getOtherAccountByIdForBankAccount

Get Other Accounts of one Account.

Returns data about all the other accounts that have shared at least one transaction with the ACCOUNT_ID at BANK_ID. Authentication is Optional

Authentication is required if the view VIEW_ID is not public.

Typical Successful Response:

								
									
{ "other_accounts":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "metadata":{ "public_alias":"NONE", "private_alias":"NONE", "more_info":"www.openbankproject.com", "URL":"www.openbankproject.com", "image_URL":"www.openbankproject.com", "open_corporates_URL":"www.openbankproject.com", "corporate_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } }, "physical_location":{ "latitude":1.231, "longitude":1.231, "date":"2017-09-19T00:00:00Z", "user":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "provider":"OBP", "display_name":"OBP" } } } }] }
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getOtherAccountsForBankAccount

Get Transactions for Account (Core)

Returns transactions list (Core info) of the account specified by ACCOUNT_ID.

Authentication is Mandatory

Possible custom headers for pagination:

  • sort_direction=ASC/DESC ==> default value: DESC. The sort field is the completed date.
  • limit=NUMBER ==> default value: 50
  • offset=NUMBER ==> default value: 0
  • from_date=DATE => default value: 0000-00-00T00:00:00.000Z
  • to_date=DATE => default value: 3049-01-01T00:00:00.000Z

Date format parameter: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'(2017-09-19T02:31:05.000Z) ==> time zone is UTC.

Typical Successful Response:

								
									
{ "transactions":[{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "this_account":{ "id":"String", "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }], "holders":[{ "name":"OBP", "is_alias":true }] }, "other_account":{ "id":"5995d6a2-01b3-423c-a173-5481df49bdaf", "holder":{ "name":"OBP", "is_alias":true }, "bank_routing":{ "scheme":"Bank_ID", "address":"gh.29.uk" }, "account_routings":[{ "scheme":"AccountNumber", "address":"4930396" }] }, "details":{ "type":"AC", "description":"OBP", "posted":"2017-09-19T00:00:00Z", "completed":"2017-09-19T00:00:00Z", "new_balance":{ "currency":"EUR", "amount":"10" }, "value":{ "currency":"EUR", "amount":"10" } } }] }
Possible Errors:
  • OBP-10023: obp_sort_direction parameter can only take two values: DESC or ASC!
  • OBP-10024: wrong value for obp_offset parameter. Please send a positive integer (=>0)!
  • OBP-10025: wrong value for obp_limit parameter. Please send a positive integer (=>1)!
  • OBP-10026: Failed to parse date string. Please use this format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'!
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Implmented in 3_0_0 by getCoreTransactionsForBankAccount