-
API
-
The terms `API` (Application Programming Interface) and `Endpoint` are used somewhat interchangeablyMore...
- Get API Info (root)
-
-
Account
-
The thing that tokens of value (money) come in and out of. An account has one or more `owners` whichMore...
- Create View
- Get access for specific user
- Get account by id
- Get accounts at all banks (Private, inc views)
- Get accounts at bank (Private)
- Get private accounts at all banks (Authenticated access)
- Get private accounts at one bank
- Get public accounts at all banks (Anonymous access)
- Update Account Label
- Update View
-
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
-
Transaction
-
Transactions are records of successful movements of value into or out of an `Account`. OBP TransacMore...
- Get Other Account of Transaction
- Get Transaction by Id
- Get Transactions for Account (Full)
-
-
Transaction Metadata
- Add a Transaction Comment
- Add a Transaction Image
- Add a Transaction Narrative
- Add a Transaction Tag
- Add a Transaction where Tag
- Delete a Transaction Comment
- Delete a Transaction Image
- Delete a Transaction Narrative
- Delete a Transaction Tag
- Delete a Transaction Tag
- Get Transaction Comments
- Get Transaction Images
- Get Transaction Tags
- Get a Transaction Narrative
- Get a Transaction where Tag
- Update a Transaction Narrative
- Update a Transaction where Tag
-
_Book Mark Bank And Account System
- Create new Book Mark Bank And Account System
- Create new My Book Mark Bank And Account System
- Delete Book Mark Bank And Account System by id
- Delete My Book Mark Bank And Account System by id
- Get Book Mark Bank And Account System List
- Get Book Mark Bank And Account System by id
- Get My Book Mark Bank And Account System List
- Get My Book Mark Bank And Account System by id
- Update Book Mark Bank And Account System
- Update My Book Mark Bank And Account System
-
_Book Mark Bank And Account(Gen1 Aeena)
- Create new Book Mark Bank And Account
- Create new My Book Mark Bank And Account
- Delete Book Mark Bank And Account by id
- Delete My Book Mark Bank And Account by id
- Get Book Mark Bank And Account List
- Get Book Mark Bank And Account by id
- Get My Book Mark Bank And Account List
- Get My Book Mark Bank And Account by id
- Update Book Mark Bank And Account
- Update My Book Mark Bank And Account
-
API
-
Account
-
Create View
-
Get access for specific user
-
Get account by id
-
Get accounts at all banks (Private, inc views)
-
Get accounts at bank (Private)
-
Get private accounts at all banks (Authenticated access)
-
Get private accounts at one bank
-
Get public accounts at all banks (Anonymous access)
-
Update Account Label
-
Update View
-
Create View
-
Account Public
-
Bank
-
Counterparty
-
Counterparty Metadata
-
Add Corporate Location to Counterparty
-
Add Counterparty More Info
-
Add Open Corporates URL to Counterparty
-
Add image url to other bank account
-
Add physical location to other bank account
-
Add public alias to other bank account
-
Add url to other bank account
-
Create Other Account Private Alias
-
Delete Counterparty Corporate Location
-
Delete Counterparty Image URL
-
Delete Counterparty Open Corporates URL
-
Delete Counterparty Physical Location
-
Delete Counterparty Private Alias
-
Delete Counterparty Public Alias
-
Delete more info of other bank account
-
Delete url of other bank account
-
Get Other Account Metadata
-
Get Other Account Private Alias
-
Get public alias of other bank account
-
Update Counterparty Corporate Location
-
Update Counterparty Image Url
-
Update Counterparty More Info
-
Update Counterparty Physical Location
-
Update Counterparty Private Alias
-
Update Open Corporates Url of Counterparty
-
Update public alias of other bank account
-
Update url of other bank account
-
Add Corporate Location to Counterparty
-
Documentation
-
Dynamic Resource Doc
-
Example test Title
-
JOPACC ATM TEST service
-
JOPACC TEST ATM 2 service
-
Swagger Petstore OpenAPI 3.1
-
Transaction
-
Transaction Metadata
-
Add a Transaction Comment
-
Add a Transaction Image
-
Add a Transaction Narrative
-
Add a Transaction Tag
-
Add a Transaction where Tag
-
Delete a Transaction Comment
-
Delete a Transaction Image
-
Delete a Transaction Narrative
-
Delete a Transaction Tag
-
Delete a Transaction Tag
-
Get Transaction Comments
-
Get Transaction Images
-
Get Transaction Tags
-
Get a Transaction Narrative
-
Get a Transaction where Tag
-
Update a Transaction Narrative
-
Update a Transaction where Tag
-
Add a Transaction Comment
-
View Custom
-
Delete Custom View
-
Get Views for Account
-
Get access
-
Grant User access to View
-
Grant User access to a list of views
-
Revoke access to all Views on Account
-
Revoke access to one View
-
Delete Custom View
-
_Book Mark Bank And Account System
-
Create new Book Mark Bank And Account System
-
Create new My Book Mark Bank And Account System
-
Delete Book Mark Bank And Account System by id
-
Delete My Book Mark Bank And Account System by id
-
Get Book Mark Bank And Account System List
-
Get Book Mark Bank And Account System by id
-
Get My Book Mark Bank And Account System List
-
Get My Book Mark Bank And Account System by id
-
Update Book Mark Bank And Account System
-
Update My Book Mark Bank And Account System
-
Create new Book Mark Bank And Account System
-
_Book Mark Bank And Account(Gen1 Aeena)
-
Create new Book Mark Bank And Account
-
Create new My Book Mark Bank And Account
-
Delete Book Mark Bank And Account by id
-
Delete My Book Mark Bank And Account by id
-
Get Book Mark Bank And Account List
-
Get Book Mark Bank And Account by id
-
Get My Book Mark Bank And Account List
-
Get My Book Mark Bank And Account by id
-
Update Book Mark Bank And Account
-
Update My Book Mark Bank And Account
-
Create new Book Mark Bank And Account
-
_Foo Bar(simonpublic1)
-
Create new Foo Bar
-
Create new My Foo Bar
-
Delete Foo Bar by id
-
Delete My Foo Bar by id
-
Get Foo Bar List
-
Get Foo Bar by id
-
Get My Foo Bar List
-
Get My Foo Bar by id
-
Update Foo Bar
-
Update My Foo Bar
-
Create new Foo Bar
-
_Hospital(mommy Map)
-
Create new Hospital
-
Create new My Hospital
-
Delete Hospital by id
-
Delete My Hospital by id
-
Get Hospital List
-
Get Hospital by id
-
Get My Hospital List
-
Get My Hospital by id
-
Update Hospital
-
Update My Hospital
-
Create new Hospital
-
_Risk Check(tobank)
-
Create new My Risk Check
-
Create new Risk Check
-
Delete My Risk Check by id
-
Delete Risk Check by id
-
Get My Risk Check List
-
Get My Risk Check by id
-
Get Risk Check List
-
Get Risk Check by id
-
Update My Risk Check
-
Update Risk Check
-
Create new My Risk Check
-
_Risk Checks(tobank)
-
Create new My Risk Checks
-
Create new Risk Checks
-
Delete My Risk Checks by id
-
Delete Risk Checks by id
-
Get My Risk Checks List
-
Get My Risk Checks by id
-
Get Risk Checks List
-
Get Risk Checks by id
-
Update My Risk Checks
-
Update Risk Checks
-
Create new My Risk Checks
-
test dynamic
v1.2.1 (151 APIs)
Get public accounts at one bank (Anonymous access)
Returns a list of the public accounts at BANK_ID. For each account the API returns the ID and the available views.
Authentication via OAuth is not required.
Authentication is Mandatory
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields:
bank_id: gh.29.uk
can_add_image_url: true
can_add_more_info: true
can_add_tag: true
can_delete_corporate_location: true
can_delete_image: true
can_delete_where_tag: true
can_edit_owner_comment: true
can_see_bank_account_bank_name: true
can_see_bank_account_currency:
can_see_bank_account_label: true
can_see_bank_account_national_identifier:
can_see_bank_account_number: true
can_see_bank_account_owners: true
can_see_bank_account_swift_bic:
can_see_corporate_location: true
can_see_image_url: true
can_see_images: true
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: true
can_see_other_account_number: true
can_see_other_account_swift_bic: true
can_see_transaction_amount: true
can_see_transaction_description: true
can_see_transaction_finish_date:
can_see_transaction_other_bank_account:
can_see_transaction_start_date:
can_see_transaction_this_bank_account:
can_see_url: true
can_see_where_tag: true
description: This an optional field. Maximum length is 2000. It can be any characters here.
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: true
label: My Account
{
"id":"123",
"label":"OBP",
"views_available":[{
"id":"123",
"short_name":"short_name",
"description":"description",
"is_public":true,
"alias":"None",
"hide_metadata_if_alias_used":true,
"can_add_comment":true,
"can_add_corporate_location":true,
"can_add_image":true,
"can_add_image_url":true,
"can_add_more_info":true,
"can_add_open_corporates_url":true,
"can_add_physical_location":true,
"can_add_private_alias":true,
"can_add_public_alias":true,
"can_add_tag":true,
"can_add_url":true,
"can_add_where_tag":true,
"can_delete_comment":true,
"can_delete_corporate_location":true,
"can_delete_image":true,
"can_delete_physical_location":true,
"can_delete_tag":true,
"can_delete_where_tag":true,
"can_edit_owner_comment":true,
"can_see_bank_account_balance":true,
"can_see_bank_account_bank_name":true,
"can_see_bank_account_currency":true,
"can_see_bank_account_iban":true,
"can_see_bank_account_label":true,
"can_see_bank_account_national_identifier":true,
"can_see_bank_account_number":true,
"can_see_bank_account_owners":true,
"can_see_bank_account_swift_bic":true,
"can_see_bank_account_type":true,
"can_see_comments":true,
"can_see_corporate_location":true,
"can_see_image_url":true,
"can_see_images":true,
"can_see_more_info":true,
"can_see_open_corporates_url":true,
"can_see_other_account_bank_name":true,
"can_see_other_account_iban":true,
"can_see_other_account_kind":true,
"can_see_other_account_metadata":true,
"can_see_other_account_national_identifier":true,
"can_see_other_account_number":true,
"can_see_other_account_swift_bic":true,
"can_see_owner_comment":true,
"can_see_physical_location":true,
"can_see_private_alias":true,
"can_see_public_alias":true,
"can_see_tags":true,
"can_see_transaction_amount":true,
"can_see_transaction_balance":true,
"can_see_transaction_currency":true,
"can_see_transaction_description":true,
"can_see_transaction_finish_date":true,
"can_see_transaction_metadata":true,
"can_see_transaction_other_bank_account":true,
"can_see_transaction_start_date":true,
"can_see_transaction_this_bank_account":true,
"can_see_transaction_type":true,
"can_see_url":true,
"can_see_where_tag":true
}],
"bank_id":"gh.29.uk"
}
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.