API Explorer

v3.1.0 (249 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Add Corporate Location to Counterparty

Add the geolocation of the counterparty's registered address

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
  • the view does not allow metadata access
  • the view does not allow adding a corporate location
  • Coordinates not possible
  • Corporate Location cannot be deleted
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addCounterpartyCorporateLocation, operation_id: OBPv1.2.1-addCounterpartyCorporateLocation

Add Counterparty More Info

Add a description of the counter party from the perpestive of the account e.g. My dentist

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • OBP-30022: The current view does not have the permission:
  • the view ownerdoes not allow adding more info
  • More Info cannot be added
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addCounterpartyMoreInfo, operation_id: OBPv1.2.1-addCounterpartyMoreInfo

Add Open Corporates URL to Counterparty

Add open corporates url to other bank account

Authentication is Optional

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow adding an open corporate url
  • URL cannot be added
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-addCounterpartyOpenCorporatesUrl

Add image url to other bank account

Add a url that points to the logo of the counterparty

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow adding an image url
  • URL cannot be added
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addCounterpartyImageUrl, operation_id: OBPv1.2.1-addCounterpartyImageUrl

Add physical location to other bank account

Add geocoordinates of the counterparty's main location

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow adding a physical location
  • Coordinates not possible
  • Physical Location cannot be added
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-addCounterpartyPhysicalLocation

Add public alias to other bank account

Creates the public alias for the other account OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

Note: Public aliases are automatically generated for new 'other accounts / counterparties', so this call should only be used if
the public alias was deleted.

The VIEW_ID parameter should be a view the caller is permitted to access to and that has permission to create public aliases.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • the view does not allow metadata access
  • the view does not allow adding a public alias
  • Alias cannot be added
  • public alias added
Implemented in OBPv1.2.1 by addCounterpartyPublicAlias, operation_id: OBPv1.2.1-addCounterpartyPublicAlias

Add url to other bank account

A url which represents the counterparty (home page url etc.)

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow adding a url
  • URL cannot be added
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addCounterpartyUrl, operation_id: OBPv1.2.1-addCounterpartyUrl

Create Other Account Private Alias

Creates a private alias for the other account OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow adding a private alias
  • Alias cannot be added
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by addOtherAccountPrivateAlias, operation_id: OBPv1.2.1-addOtherAccountPrivateAlias

Delete Counterparty Corporate Location

Delete corporate location of other bank account. Delete the geolocation of the counterparty's registered address

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
  • the view does not allow metadata access
  • Corporate Location cannot be deleted
  • Delete not completed
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyCorporateLocation, operation_id: OBPv1.2.1-deleteCounterpartyCorporateLocation

Delete Counterparty Image URL

Delete image url of other bank account

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyImageUrl, operation_id: OBPv1.2.1-deleteCounterpartyImageUrl

Delete Counterparty Open Corporates URL

Delete open corporate url of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
  • the view does not allow metadata access
  • the view does not allow deleting an open corporate url
  • URL cannot be deleted
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl

Delete Counterparty Physical Location

Delete physical location of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-30022: The current view does not have the permission:
  • Physical Location cannot be deleted
  • Delete not completed
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-deleteCounterpartyPhysicalLocation

Delete Counterparty Private Alias

Deletes the private alias of the other account OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • the view does not allow metadata access
  • the view does not allow deleting the private alias
  • Alias cannot be deleted
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyPrivateAlias, operation_id: OBPv1.2.1-deleteCounterpartyPrivateAlias

Delete Counterparty Public Alias

Deletes the public alias of the other account OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • the view does not allow metadata access
  • the view does not allow deleting the public alias
  • Alias cannot be deleted
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyPublicAlias, operation_id: OBPv1.2.1-deleteCounterpartyPublicAlias

Delete more info of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
  • the view does not allow metadata access
  • the view does not allow deleting more info
  • More Info cannot be deleted
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyMoreInfo, operation_id: OBPv1.2.1-deleteCounterpartyMoreInfo

Delete url of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "jsonString":"{}" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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.
  • the view does not allow metadata access
  • the view does not allow deleting a url
  • URL cannot be deleted
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by deleteCounterpartyUrl, operation_id: OBPv1.2.1-deleteCounterpartyUrl

Get Other Account Metadata

Get metadata of one other account.
Returns only the metadata about one other bank account (OTHER_ACCOUNT_ID) that had shared at least one transaction with ACCOUNT_ID at BANK_ID.

Authentication via OAuth is required if the view is not public.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "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":"http://127.0.0.1:8080", "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":"http://127.0.0.1:8080", "display_name":"OBP" } } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • the view does not allow metadata access
Implemented in OBPv1.2.1 by getOtherAccountMetadata, operation_id: OBPv1.2.1-getOtherAccountMetadata

Get Other Account Private Alias

Returns the private alias of the other account OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "alias":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • the view does not allow metadata access
  • the view does not allow private alias access
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by getOtherAccountPrivateAlias, operation_id: OBPv1.2.1-getOtherAccountPrivateAlias

Get public alias of other bank account

Returns the public alias of the other account OTHER_ACCOUNT_ID.
Authentication is Optional
Authentication is Mandatory if the view is not public.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "alias":"String" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
  • the view does not allow metadata access
  • the view does not allow public alias access
  • OBP-20001: User not logged in. Authentication is required!
Implemented in OBPv1.2.1 by getCounterpartyPublicAlias, operation_id: OBPv1.2.1-getCounterpartyPublicAlias

Update Counterparty Corporate Location

Update the geolocation of the counterparty's registered address

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating a corporate location
  • Coordinates not possible
  • Corporate Location cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyCorporateLocation, operation_id: OBPv1.2.1-updateCounterpartyCorporateLocation

Update Counterparty Image Url

Update the url that points to the logo of the counterparty

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating an image url
  • URL cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyImageUrl, operation_id: OBPv1.2.1-updateCounterpartyImageUrl

Update Counterparty More Info

Update the more info description of the counter party from the perpestive of the account e.g. My dentist

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating more info
  • More Info cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyMoreInfo, operation_id: OBPv1.2.1-updateCounterpartyMoreInfo

Update Counterparty Physical Location

Update geocoordinates of the counterparty's main location

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating a physical location
  • Coordinates not possible
  • Physical Location cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-updateCounterpartyPhysicalLocation

Update Counterparty Private Alias

Updates the private alias of the counterparty (AKA other account) OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating the private alias
  • Alias cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyPrivateAlias, operation_id: OBPv1.2.1-updateCounterpartyPrivateAlias

Update Open Corporates Url of Counterparty

Update open corporate url of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating an open corporate url
  • URL cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-updateCounterpartyOpenCorporatesUrl

Update public alias of other bank account

Updates the public alias of the other account / counterparty OTHER_ACCOUNT_ID.

Authentication is Optional
Authentication is required if the view is not public.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • the view does not allow metadata access
  • the view does not allow updating the public alias
  • Alias cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyPublicAlias, operation_id: OBPv1.2.1-updateCounterpartyPublicAlias

Update url of other bank account

A url which represents the counterparty (home page url etc.)

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "success":"Success" }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-10001: Incorrect json format.
  • OBP-30022: The current view does not have the permission:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • URL cannot be updated
  • OBP-50000: Unknown Error.
Implemented in OBPv1.2.1 by updateCounterpartyUrl, operation_id: OBPv1.2.1-updateCounterpartyUrl