v5.1.0 filtered by tag: View-System (5 APIs)
Create System View
Create a system view
Authentication is Mandatory and the user needs to have access to the CanCreateSystemView entitlement.
The 'allowed_actions' field is a list containing the names of the actions allowed through this view.
All the actions contained in the list will be set to true
on the view creation, the rest will be set to false
.
The 'alias' field in the JSON can take one of three values:
- public: to use the public alias if there is one specified for the other account.
- private: to use the private alias if there is one specified for the other account.
- ''(empty string): to use no alias; the view shows the real name of the other account.
The 'hide_metadata_if_alias_used' field in the JSON can take boolean values. If it is set to true
and there is an alias on the other account then the other accounts' metadata (like more_info, url, image_url, open_corporates_url, etc.) will be hidden. Otherwise the metadata will be shown.
System views cannot be public. In case you try to set it you will get the error OBP-30258: System view cannot be public
JSON request body fields:
description: This an optional field. Maximum length is 2000. It can be any characters here.
hide_metadata_if_alias_used: false
is_public: false
name: ACCOUNT_MANAGEMENT_FEE
which_alias_to_use: public
can_grant_access_to_views: can_grant_access_to_views
can_revoke_access_to_views: can_revoke_access_to_views
JSON response body fields:
can_add_counterparty: false
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_add_transaction_request_to_any_account:
can_add_transaction_request_to_own_account:
can_create_direct_debit: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_grant_access_to_views: can_grant_access_to_views
can_query_available_funds: false
can_revoke_access_to_views: can_revoke_access_to_views
can_see_bank_account_bank_name: false
can_see_bank_account_credit_limit: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_routing_address:
can_see_bank_account_routing_scheme:
can_see_bank_account_swift_bic:
can_see_bank_routing_address: false
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_routing_address: false
can_see_other_account_routing_scheme:
can_see_other_account_swift_bic: false
can_see_other_bank_routing_address:
can_see_other_bank_routing_scheme:
can_see_transaction_amount: false
can_see_transaction_description: false
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: false
can_see_where_tag: false
description: This an optional field. Maximum length is 2000. It can be any characters here.
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
is_system: true
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"is_system":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_grant_access_to_views":["owner"],
"can_revoke_access_to_views":["owner"],
"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_add_counterparty":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_query_available_funds":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,
"can_see_bank_routing_scheme":true,
"can_see_bank_routing_address":true,
"can_see_bank_account_routing_scheme":true,
"can_see_bank_account_routing_address":true,
"can_see_other_bank_routing_scheme":true,
"can_see_other_bank_routing_address":true,
"can_see_other_account_routing_scheme":true,
"can_see_other_account_routing_address":true,
"can_add_transaction_request_to_own_account":true,
"can_add_transaction_request_to_any_account":true,
"can_see_bank_account_credit_limit":true,
"can_create_direct_debit":true,
"can_create_standing_order":true
}
-
CanCreateSystemView
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.
- OBP-20006: User is missing one or more roles:
Delete System View
Deletes the system view specified by VIEW_ID
Authentication is Mandatory
URL Parameters:
VIEW_ID: owner
JSON response body fields:
-
CanDeleteSystemView
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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-50000: Unknown Error.
- user does not have owner access
- OBP-20006: User is missing one or more roles:
Get Ids of System Views
{
"views":[{
"id":"owner"
}]
}
-
CanGetSystemView
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
- OBP-20006: User is missing one or more roles:
Get System View
Get System View
Authentication is Mandatory
URL Parameters:
VIEW_ID: owner
JSON response body fields:
can_add_counterparty: false
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_add_transaction_request_to_any_account:
can_add_transaction_request_to_own_account:
can_create_direct_debit: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_grant_access_to_views: can_grant_access_to_views
can_query_available_funds: false
can_revoke_access_to_views: can_revoke_access_to_views
can_see_bank_account_bank_name: false
can_see_bank_account_credit_limit: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_routing_address:
can_see_bank_account_routing_scheme:
can_see_bank_account_swift_bic:
can_see_bank_routing_address: false
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_routing_address: false
can_see_other_account_routing_scheme:
can_see_other_account_swift_bic: false
can_see_other_bank_routing_address:
can_see_other_bank_routing_scheme:
can_see_transaction_amount: false
can_see_transaction_description: false
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: false
can_see_where_tag: false
description: This an optional field. Maximum length is 2000. It can be any characters here.
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
is_system: true
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"is_system":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_grant_access_to_views":["owner"],
"can_revoke_access_to_views":["owner"],
"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_add_counterparty":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_query_available_funds":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,
"can_see_bank_routing_scheme":true,
"can_see_bank_routing_address":true,
"can_see_bank_account_routing_scheme":true,
"can_see_bank_account_routing_address":true,
"can_see_other_bank_routing_scheme":true,
"can_see_other_bank_routing_address":true,
"can_see_other_account_routing_scheme":true,
"can_see_other_account_routing_address":true,
"can_add_transaction_request_to_own_account":true,
"can_add_transaction_request_to_any_account":true,
"can_see_bank_account_credit_limit":true,
"can_create_direct_debit":true,
"can_create_standing_order":true
}
-
CanGetSystemView
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- 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.
- OBP-20006: User is missing one or more roles:
Update System View
Update an existing view on a bank account
Authentication is Mandatory and the user needs to have access to the owner view.
The json sent is the same as during view creation (above), with one difference: the 'name' field
of a view is not editable (it is only set when a view is created)
URL Parameters:
VIEW_ID: owner
JSON response body fields:
can_add_counterparty: false
can_add_image_url: false
can_add_more_info: false
can_add_tag: false
can_add_transaction_request_to_any_account:
can_add_transaction_request_to_own_account:
can_create_direct_debit: false
can_delete_corporate_location: false
can_delete_image: false
can_delete_where_tag: false
can_edit_owner_comment: false
can_grant_access_to_views: can_grant_access_to_views
can_query_available_funds: false
can_revoke_access_to_views: can_revoke_access_to_views
can_see_bank_account_bank_name: false
can_see_bank_account_credit_limit: false
can_see_bank_account_currency:
can_see_bank_account_label: false
can_see_bank_account_national_identifier:
can_see_bank_account_number: false
can_see_bank_account_owners: false
can_see_bank_account_routing_address:
can_see_bank_account_routing_scheme:
can_see_bank_account_swift_bic:
can_see_bank_routing_address: false
can_see_corporate_location: false
can_see_image_url: false
can_see_images: false
can_see_other_account_bank_name:
can_see_other_account_metadata:
can_see_other_account_national_identifier: false
can_see_other_account_number: false
can_see_other_account_routing_address: false
can_see_other_account_routing_scheme:
can_see_other_account_swift_bic: false
can_see_other_bank_routing_address:
can_see_other_bank_routing_scheme:
can_see_transaction_amount: false
can_see_transaction_description: false
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: false
can_see_where_tag: false
description: This an optional field. Maximum length is 2000. It can be any characters here.
hide_metadata_if_alias_used: false
id: d8839721-ad8f-45dd-9f78-2080414b93f9
is_public: false
is_system: true
{
"id":"1234",
"short_name":"short_name",
"description":"description",
"metadata_view":"owner",
"is_public":true,
"is_system":true,
"alias":"No",
"hide_metadata_if_alias_used":true,
"can_grant_access_to_views":["owner"],
"can_revoke_access_to_views":["owner"],
"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_add_counterparty":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_query_available_funds":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,
"can_see_bank_routing_scheme":true,
"can_see_bank_routing_address":true,
"can_see_bank_account_routing_scheme":true,
"can_see_bank_account_routing_address":true,
"can_see_other_bank_routing_scheme":true,
"can_see_other_bank_routing_address":true,
"can_see_other_account_routing_scheme":true,
"can_see_other_account_routing_address":true,
"can_add_transaction_request_to_own_account":true,
"can_add_transaction_request_to_any_account":true,
"can_see_bank_account_credit_limit":true,
"can_create_direct_debit":true,
"can_create_standing_order":true
}
-
CanUpdateSystemView
- Please login to request this Role
- Required JSON Validation: No
- Allowed Authentication Types: Not set
- OBP-10001: Incorrect json format.
- 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-50000: Unknown Error.
- OBP-20006: User is missing one or more roles: