right logo image
right logo image
Log on
⯆

API Explorer

v5.1.0 filtered by tag: Counterparty (39 APIs)

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

Create Counterparty (Explicit)

This endpoint creates an (Explicit) Counterparty for an Account.

For an introduction to Counterparties in OBP see here

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

VIEW_ID: owner

JSON request body fields:

bespoke:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

value: 5987953

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Typical Successful Response: 

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by createCounterparty, operation_id: OBPv4.0.0-createCounterparty Tags: Counterparty, Account,

Create Counterparty for any account (Explicit)

This is a management endpoint that allows the creation of a Counterparty on any Account.

For an introduction to Counterparties in OBP, see here

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

VIEW_ID: owner

JSON request body fields:

bespoke:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

value: 5987953

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Typical Successful Response: 

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Required Roles:
  • CanCreateCounterparty - Please login to request this Role
  • CanCreateCounterpartyAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-30003: Account not found. Please specify a valid value for ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10003: Invalid Currency Value. It should be three letters ISO Currency Code.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30014: Counterparty already exists. Please specify a different value for BANK_ID or ACCOUNT_ID or VIEW_ID or NAME.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by createCounterpartyForAnyAccount, operation_id: OBPv4.0.0-createCounterpartyForAnyAccount Tags: Counterparty, Account,

Delete Counterparty (Explicit)

This endpoint deletes the Counterparty on the Account / View specified by the COUNTERPARTY_ID.
It also deletes any related Counterparty Metadata.

The User calling this endpoint must have access to the View specified in the URL and that View must have the permission can_delete_counterparty.

For a general introduction to Counterparties in OBP see here

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

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON request body fields:

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-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteExplicitCounterparty, operation_id: OBPv4.0.0-deleteExplicitCounterparty Tags: Counterparty, Account,

Delete Counterparty for any account (Explicit)

This is a management endpoint that enables the deletion of any specified Counterparty along with any related Metadata of that Counterparty.

For a general introduction to Counterparties in OBP, see here

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

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

Typical Successful Response:
Required Roles:
  • CanDeleteCounterparty - Please login to request this Role
  • CanDeleteCounterpartyAtAnyBank - Please login to request this Role
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-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by deleteCounterpartyForAnyAccount, operation_id: OBPv4.0.0-deleteCounterpartyForAnyAccount Tags: Counterparty, Account,

Get Counterparties (Explicit)

Get the Counterparties that have been explicitly created on the specified Account / View.

For a general introduction to Counterparties in OBP, see here

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

VIEW_ID: owner

JSON response body fields:

bespoke:

counterparties:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

this_account_id:

this_bank_id:

this_view_id:

value: 5987953

Typical Successful Response: 

								
									
{
  "counterparties":[{
    "name":"CounterpartyName",
    "description":"My landlord",
    "currency":"EUR",
    "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "this_bank_id":"gh.29.uk",
    "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "this_view_id":"owner",
    "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "other_bank_routing_scheme":"OBP",
    "other_bank_routing_address":"gh.29.uk",
    "other_branch_routing_scheme":"OBP",
    "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_routing_scheme":"OBP",
    "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_secondary_routing_scheme":"IBAN",
    "other_account_secondary_routing_address":"DE89370400440532013000",
    "is_beneficiary":true,
    "bespoke":[{
      "key":"englishName",
      "value":"english Name"
    }]
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getExplicitCounterpartiesForAccount, operation_id: OBPv4.0.0-getExplicitCounterpartiesForAccount Tags: Counterparty, Payment Initiation Service (PIS), PSD2, Account,

Get Counterparties for any account (Explicit)

This is a management endpoint that gets the Counterparties that have been explicitly created for an Account / View.

For a general introduction to Counterparties in OBP, see here

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

VIEW_ID: owner

JSON response body fields:

bespoke:

counterparties:

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

description: Description of the object. Maximum length is 2000. It can be any characters here.

is_beneficiary: false

key: CustomerNumber

name: ACCOUNT_MANAGEMENT_FEE

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

this_account_id:

this_bank_id:

this_view_id:

value: 5987953

Typical Successful Response: 

								
									
{
  "counterparties":[{
    "name":"CounterpartyName",
    "description":"My landlord",
    "currency":"EUR",
    "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "this_bank_id":"gh.29.uk",
    "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
    "this_view_id":"owner",
    "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
    "other_bank_routing_scheme":"OBP",
    "other_bank_routing_address":"gh.29.uk",
    "other_branch_routing_scheme":"OBP",
    "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_routing_scheme":"OBP",
    "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
    "other_account_secondary_routing_scheme":"IBAN",
    "other_account_secondary_routing_address":"DE89370400440532013000",
    "is_beneficiary":true,
    "bespoke":[{
      "key":"englishName",
      "value":"english Name"
    }]
  }]
}
Required Roles:
  • CanGetCounterparties - Please login to request this Role
  • CanGetCounterpartiesAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-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:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCounterpartiesForAnyAccount, operation_id: OBPv4.0.0-getCounterpartiesForAnyAccount Tags: Counterparty, Payment Initiation Service (PIS), PSD2, Account,

Get Counterparty by Id (Explicit)

This endpoint returns a single Counterparty on an Account View specified by its COUNTERPARTY_ID:

For a general introduction to Counterparties in OBP, see here

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

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Typical Successful Response: 

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-20017: Current user does not have access to the view. Please specify a valid value for VIEW_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getExplicitCounterpartyById, operation_id: OBPv4.0.0-getExplicitCounterpartyById Tags: Counterparty, Payment Initiation Service (PIS), PSD2, Counterparty-Metadata,

Get Counterparty by Id for any account (Explicit)

This is a management endpoint that gets information about any single explicitly created Counterparty on an Account / View specified by its COUNTERPARTY_ID",

For a general introduction to Counterparties in OBP, see here

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

COUNTERPARTY_ID: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

VIEW_ID: owner

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Typical Successful Response: 

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Required Roles:
  • CanGetCounterpartyAtAnyBank - Please login to request this Role
  • CanGetCounterparty - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCounterpartyByIdForAnyAccount, operation_id: OBPv4.0.0-getCounterpartyByIdForAnyAccount Tags: Counterparty, Account,

Get Counterparty by name for any account (Explicit)

This is a management endpoint that allows the retrieval of any Counterparty on an Account / View by its Name.

For a general introduction to Counterparties in OBP, see here

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

COUNTERPARTY_NAME: John Smith Ltd.

VIEW_ID: owner

JSON response body fields:

bespoke:

corporate_location: 10

counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh

created_by_user_id:

currency: EUR

date: 2020-01-27

description: Description of the object. Maximum length is 2000. It can be any characters here.

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

image_url:

is_beneficiary: false

key: CustomerNumber

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_url:

other_account_routing_address:

other_account_routing_scheme:

other_account_secondary_routing_address:

other_account_secondary_routing_scheme:

other_bank_routing_address:

other_bank_routing_scheme:

other_branch_routing_address:

other_branch_routing_scheme:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

this_account_id:

this_bank_id:

this_view_id:

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

user:

username: felixsmith

value: 5987953

Typical Successful Response: 

								
									
{
  "name":"CounterpartyName",
  "description":"My landlord",
  "currency":"EUR",
  "created_by_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
  "this_bank_id":"gh.29.uk",
  "this_account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0",
  "this_view_id":"owner",
  "counterparty_id":"9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh",
  "other_bank_routing_scheme":"OBP",
  "other_bank_routing_address":"gh.29.uk",
  "other_branch_routing_scheme":"OBP",
  "other_branch_routing_address":"12f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_routing_scheme":"OBP",
  "other_account_routing_address":"36f8a9e6-c2b1-407a-8bd0-421b7119307e",
  "other_account_secondary_routing_scheme":"IBAN",
  "other_account_secondary_routing_address":"DE89370400440532013000",
  "is_beneficiary":true,
  "bespoke":[{
    "key":"englishName",
    "value":"english Name"
  }],
  "metadata":{
    "public_alias":"String",
    "more_info":"String",
    "url":"String",
    "image_url":"String",
    "open_corporates_url":"String",
    "corporate_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"1100-01-01T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
Required Roles:
  • CanGetCounterpartyAtAnyBank - Please login to request this Role
  • CanGetCounterparty - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30110: Invalid Account Id. The ACCOUNT_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30111: Invalid Bank Id. The BANK_ID should only contain 0-9/a-z/A-Z/'-'/'.'/'_', the length should be smaller than 255.
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-10001: Incorrect json format.
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by getCounterpartyByNameForAnyAccount, operation_id: OBPv4.0.0-getCounterpartyByNameForAnyAccount Tags: Counterparty, Account,

Get Other Account by Id

Returns data about the Other Account that has shared at least one transaction with ACCOUNT_ID at BANK_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:

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

account_routings:

address:

bank_routing:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

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

image_URL:

is_alias:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

scheme: OBP

user:

Typical Successful Response: 

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "bank_routing":{
    "scheme":"OBP",
    "address":"gh.29.uk"
  },
  "account_routings":[{
    "scheme":"OBP",
    "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
  }],
  "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":"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-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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getOtherAccountByIdForBankAccount, operation_id: OBPv3.0.0-getOtherAccountByIdForBankAccount Tags: Counterparty, Account,

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

Authentication is required if the view VIEW_ID is not public.

URL Parameters:

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

BANK_ID: gh.29.uk

VIEW_ID: owner

JSON response body fields:

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

account_routings:

address:

bank_routing:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

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

image_URL:

is_alias:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

open_corporates_URL:

other_accounts:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

scheme: OBP

user:

Typical Successful Response: 

								
									
{
  "other_accounts":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "holder":{
      "name":"OBP",
      "is_alias":true
    },
    "bank_routing":{
      "scheme":"OBP",
      "address":"gh.29.uk"
    },
    "account_routings":[{
      "scheme":"OBP",
      "address":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0"
    }],
    "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":"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-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-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getOtherAccountsForBankAccount, operation_id: OBPv3.0.0-getOtherAccountsForBankAccount Tags: Counterparty, Account,

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,

Get Other Account of Transaction

Get other account of a transaction.
Returns details of the other party involved in the transaction, moderated by the view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

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

TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub

VIEW_ID: owner

JSON response body fields:

IBAN: DE91 1000 0000 0123 4567 89

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

bank:

corporate_location: 10

date: 2020-01-27

display_name:

holder:

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

image_URL:

is_alias:

kind:

latitude: 38.8951

longitude: -77.0364

metadata:

more_info: More information about this fee

name: ACCOUNT_MANAGEMENT_FEE

national_identifier:

number:

open_corporates_URL:

physical_location:

private_alias:

provider: ETHEREUM

public_alias:

swift_bic:

user:

Typical Successful Response: 

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "holder":{
    "name":"OBP",
    "is_alias":true
  },
  "number":"123",
  "kind":"3456",
  "IBAN":"UK234DB",
  "swift_bic":"UK12321DB",
  "bank":{
    "national_identifier":"OBP",
    "name":"OBP"
  },
  "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":"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-30018: Bank Account not found. Please specify valid values for BANK_ID and ACCOUNT_ID.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv1.2.1, function_name: by getOtherAccountForTransaction, operation_id: OBPv1.2.1-getOtherAccountForTransaction Tags: Transaction, Counterparty,