right logo image
right logo image
Log on
⯆

API Explorer

Log off

v3.1.0 (327 APIs)

API Host: https://apisandbox.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Add Corporate Location to Counterparty

Add the geolocation of the counterparty's registered address

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

corporate_location: 10

latitude: 38.8951

longitude: -77.0364

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyCorporateLocation, operation_id: OBPv1.2.1-addCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

Add Counterparty More Info

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

more_info: More information about this fee

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyMoreInfo, operation_id: OBPv1.2.1-addCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty,

Add Open Corporates URL to Counterparty

Add open corporates url to other bank account

User Authentication is Optional. The User need not be logged in.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

open_corporates_URL:

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-addCounterpartyOpenCorporatesUrl Tags: Counterparty-Metadata, Counterparty,

Add image url to other bank account

Add a url that points to the logo of the counterparty

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

image_URL:

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyImageUrl, operation_id: OBPv1.2.1-addCounterpartyImageUrl Tags: Counterparty-Metadata, Counterparty,

Add physical location to other bank account

Add geocoordinates of the counterparty's main location

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

latitude: 38.8951

longitude: -77.0364

physical_location:

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-addCounterpartyPhysicalLocation Tags: Counterparty-Metadata, Counterparty,

Add public alias to other bank account

Creates the public alias for the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
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:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

alias:

JSON response body fields:

success:

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
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyPublicAlias, operation_id: OBPv1.2.1-addCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

Add url to other bank account

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

URL: http://www.example.com/id-docs/123/image.png

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addCounterpartyUrl, operation_id: OBPv1.2.1-addCounterpartyUrl Tags: Counterparty-Metadata, Counterparty,

Create Other Account Private Alias

Creates a private alias for the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON request body fields:

alias:

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by addOtherAccountPrivateAlias, operation_id: OBPv1.2.1-addOtherAccountPrivateAlias Tags: Counterparty-Metadata, Counterparty,

Delete Counterparty Corporate Location

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyCorporateLocation, operation_id: OBPv1.2.1-deleteCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

Delete Counterparty Image URL

Delete image url of other bank account

User Authentication is Optional. The User need not be logged in.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyImageUrl, operation_id: OBPv1.2.1-deleteCounterpartyImageUrl Tags: Counterparty-Metadata, Counterparty,

Delete Counterparty Open Corporates URL

Delete open corporate url of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl Tags: Counterparty-Metadata, Counterparty,

Delete Counterparty Physical Location

Delete physical location of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-deleteCounterpartyPhysicalLocation Tags: Counterparty-Metadata, Counterparty,

Delete Counterparty Private Alias

Deletes the private alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyPrivateAlias, operation_id: OBPv1.2.1-deleteCounterpartyPrivateAlias Tags: Counterparty-Metadata, Counterparty,

Delete Counterparty Public Alias

Deletes the public alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyPublicAlias, operation_id: OBPv1.2.1-deleteCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

Delete more info of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyMoreInfo, operation_id: OBPv1.2.1-deleteCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty,

Delete url of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
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.
Connector Methods:
Version: OBPv1.2.1, function_name: by deleteCounterpartyUrl, operation_id: OBPv1.2.1-deleteCounterpartyUrl Tags: Counterparty-Metadata, Counterparty,

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.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

URL: http://www.example.com/id-docs/123/image.png

corporate_location: 10

date: 2020-01-27

display_name:

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

image_URL:

latitude: 38.8951

longitude: -77.0364

more_info: More information about this fee

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

user:

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":"1100-01-01T00: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":"1100-01-01T00: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
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountMetadata, operation_id: OBPv1.2.1-getOtherAccountMetadata Tags: Counterparty-Metadata, Counterparty,

Get Other Account Private Alias

Returns the private alias of the other account OTHER_ACCOUNT_ID.

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

alias:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountPrivateAlias, operation_id: OBPv1.2.1-getOtherAccountPrivateAlias Tags: Counterparty-Metadata, Counterparty,

Get public alias of other bank account

Returns the public alias of the other account OTHER_ACCOUNT_ID.
User Authentication is Optional. The User need not be logged in.
User Authentication is Required. The User must be logged in. The Application must also be authenticated. if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

alias:

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!
Connector Methods:
Version: OBPv1.2.1, function_name: by getCounterpartyPublicAlias, operation_id: OBPv1.2.1-getCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

Update Counterparty Corporate Location

Update the geolocation of the counterparty's registered address

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyCorporateLocation, operation_id: OBPv1.2.1-updateCounterpartyCorporateLocation Tags: Counterparty-Metadata, Counterparty,

Update Counterparty Image Url

Update the url that points to the logo of the counterparty

User Authentication is Optional. The User need not be logged in.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyImageUrl, operation_id: OBPv1.2.1-updateCounterpartyImageUrl Tags: Counterparty-Metadata, Counterparty,

Update Counterparty More Info

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyMoreInfo, operation_id: OBPv1.2.1-updateCounterpartyMoreInfo Tags: Counterparty-Metadata, Counterparty,

Update Counterparty Physical Location

Update geocoordinates of the counterparty's main location

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-updateCounterpartyPhysicalLocation Tags: Counterparty-Metadata, Counterparty,

Update Counterparty Private Alias

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

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyPrivateAlias, operation_id: OBPv1.2.1-updateCounterpartyPrivateAlias Tags: Counterparty-Metadata, Counterparty,

Update Open Corporates Url of Counterparty

Update open corporate url of other bank account

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-updateCounterpartyOpenCorporatesUrl Tags: Counterparty-Metadata, Counterparty,

Update public alias of other bank account

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

User Authentication is Optional. The User need not be logged in.
Authentication is required if the view is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyPublicAlias, operation_id: OBPv1.2.1-updateCounterpartyPublicAlias Tags: Counterparty-Metadata, Counterparty,

Update url of other bank account

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

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

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

BANK_ID: gh.29.uk

OTHER_ACCOUNT_ID:

VIEW_ID: owner

JSON response body fields:

success:

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.
Connector Methods:
Version: OBPv1.2.1, function_name: by updateCounterpartyUrl, operation_id: OBPv1.2.1-updateCounterpartyUrl Tags: Counterparty-Metadata, Counterparty,