right logo image
right logo image
Log on

v4.0.0 filtered by tag: Transaction-Metadata, Counterparty-Metadata (45 APIs)

API Host: https://psd2-api.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

Get Counterparty by Counterparty Id (Explicit)

Information returned about the Counterparty specified by COUNTERPARTY_ID:

Authentication is Mandatory

URL Parameters:

JSON response body fields:

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":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "physical_location":{
      "latitude":11.45,
      "longitude":11.45,
      "date":"2017-09-19T00:00:00Z",
      "user":{
        "id":"123",
        "provider":"http://127.0.0.1:8080",
        "username":"felixsmith"
      }
    },
    "private_alias":"String"
  }
}
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:
Implemented in OBPv4.0.0 by getExplictCounterpartyById, operation_id: OBPv4.0.0-getExplictCounterpartyById

Add Corporate Location to Counterparty

Add the geolocation of the counterparty's registered address

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyCorporateLocation, operation_id: OBPv1.2.1-addCounterpartyCorporateLocation

Add Counterparty More Info

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

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyMoreInfo, operation_id: OBPv1.2.1-addCounterpartyMoreInfo

Add Open Corporates URL to Counterparty

Add open corporates url to other bank account

Authentication is Optional

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-addCounterpartyOpenCorporatesUrl

Add image url to other bank account

Add a url that points to the logo of the counterparty

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyImageUrl, operation_id: OBPv1.2.1-addCounterpartyImageUrl

Add physical location to other bank account

Add geocoordinates of the counterparty's main location

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-addCounterpartyPhysicalLocation

Add public alias to other bank account

Creates the public alias for the other account OTHER_ACCOUNT_ID.

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

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

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

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyPublicAlias, operation_id: OBPv1.2.1-addCounterpartyPublicAlias

Add url to other bank account

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

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addCounterpartyUrl, operation_id: OBPv1.2.1-addCounterpartyUrl

Create Other Account Private Alias

Creates a private alias for the other account OTHER_ACCOUNT_ID.

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

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by addOtherAccountPrivateAlias, operation_id: OBPv1.2.1-addOtherAccountPrivateAlias

Delete Counterparty Corporate Location

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyCorporateLocation, operation_id: OBPv1.2.1-deleteCounterpartyCorporateLocation

Delete Counterparty Image URL

Delete image url of other bank account

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Possible Errors:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by deleteCounterpartyImageUrl, operation_id: OBPv1.2.1-deleteCounterpartyImageUrl

Delete Counterparty Open Corporates URL

Delete open corporate url of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-deleteCounterpartyOpenCorporatesUrl

Delete Counterparty Physical Location

Delete physical location of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-deleteCounterpartyPhysicalLocation

Delete Counterparty Private Alias

Deletes the private alias of the other account OTHER_ACCOUNT_ID.

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

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyPrivateAlias, operation_id: OBPv1.2.1-deleteCounterpartyPrivateAlias

Delete Counterparty Public Alias

Deletes the public alias of the other account OTHER_ACCOUNT_ID.

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

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyPublicAlias, operation_id: OBPv1.2.1-deleteCounterpartyPublicAlias

Delete more info of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyMoreInfo, operation_id: OBPv1.2.1-deleteCounterpartyMoreInfo

Delete url of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
Implemented in OBPv1.2.1 by deleteCounterpartyUrl, operation_id: OBPv1.2.1-deleteCounterpartyUrl

Get Other Account Metadata

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

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "public_alias":"NONE",
  "private_alias":"NONE",
  "more_info":"www.openbankproject.com",
  "URL":"www.openbankproject.com",
  "image_URL":"www.openbankproject.com",
  "open_corporates_URL":"www.openbankproject.com",
  "corporate_location":{
    "latitude":1.231,
    "longitude":1.231,
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  },
  "physical_location":{
    "latitude":1.231,
    "longitude":1.231,
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }
}
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
  • the view does not allow metadata access
Connector Methods:
Implemented in OBPv1.2.1 by getOtherAccountMetadata, operation_id: OBPv1.2.1-getOtherAccountMetadata

Get Other Account Private Alias

Returns the private alias of the other account OTHER_ACCOUNT_ID.

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

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "alias":"String"
}
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:
Implemented in OBPv1.2.1 by getOtherAccountPrivateAlias, operation_id: OBPv1.2.1-getOtherAccountPrivateAlias

Get public alias of other bank account

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

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "alias":"String"
}
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:
Implemented in OBPv1.2.1 by getCounterpartyPublicAlias, operation_id: OBPv1.2.1-getCounterpartyPublicAlias

Update Counterparty Corporate Location

Update the geolocation of the counterparty's registered address

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyCorporateLocation, operation_id: OBPv1.2.1-updateCounterpartyCorporateLocation

Update Counterparty Image Url

Update the url that points to the logo of the counterparty

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyImageUrl, operation_id: OBPv1.2.1-updateCounterpartyImageUrl

Update Counterparty More Info

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyMoreInfo, operation_id: OBPv1.2.1-updateCounterpartyMoreInfo

Update Counterparty Physical Location

Update geocoordinates of the counterparty's main location

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyPhysicalLocation, operation_id: OBPv1.2.1-updateCounterpartyPhysicalLocation

Update Counterparty Private Alias

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

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

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyPrivateAlias, operation_id: OBPv1.2.1-updateCounterpartyPrivateAlias

Update Open Corporates Url of Counterparty

Update open corporate url of other bank account

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyOpenCorporatesUrl, operation_id: OBPv1.2.1-updateCounterpartyOpenCorporatesUrl

Update public alias of other bank account

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

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

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyPublicAlias, operation_id: OBPv1.2.1-updateCounterpartyPublicAlias

Update url of other bank account

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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:
Implemented in OBPv1.2.1 by updateCounterpartyUrl, operation_id: OBPv1.2.1-updateCounterpartyUrl

Add a tag

Posts a tag about a transaction TRANSACTION_ID on a view VIEW_ID.

Authentication is Mandatory

Authentication is required as the tag is linked with the user.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}
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
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addTagForViewOnTransaction, operation_id: OBPv1.2.1-addTagForViewOnTransaction

Add an image

Posts an image about a transaction TRANSACTION_ID on a view VIEW_ID.

Authentication is Mandatory

The image is linked with the user.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "label":"NONE",
  "URL":"www.openbankproject.com",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-10017: Incorrect URL Format.
  • OBP-50000: Unknown Error.
  • OBP-20001: User not logged in. Authentication is required!
Connector Methods:
Implemented in OBPv1.2.1 by addImageForViewOnTransaction, operation_id: OBPv1.2.1-addImageForViewOnTransaction

Add comment

Posts a comment about a transaction TRANSACTION_ID on a view VIEW_ID.

${authenticationRequiredMessage(false)}

Authentication is required since the comment is linked with the user.

Authentication is Mandatory

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addCommentForViewOnTransaction, operation_id: OBPv1.2.1-addCommentForViewOnTransaction

Add narrative

Creates a description of the transaction TRANSACTION_ID.

Note: Unlike other items of metadata, there is only one "narrative" per transaction accross all views.
If you set narrative via a view e.g. view-x it will be seen via view-y (as long as view-y has permission to see the narrative).

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

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addTransactionNarrative, operation_id: OBPv1.2.1-addTransactionNarrative

Add where tag

Creates a "where" Geo tag on a transaction TRANSACTION_ID in a view.

Authentication is Mandatory

The geo tag is linked with the user.

URL Parameters:

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by addWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-addWhereTagForViewOnTransaction

Delete a tag

Deletes the tag TAG_ID about the transaction TRANSACTION_ID made on view.
Authentication via OAuth is required. The user must either have owner privileges for this account,
or must be the user that posted the tag.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Possible Errors:
  • 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
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by deleteTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteTagForViewOnTransaction

Delete an image

Deletes the image IMAGE_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the image.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Possible Errors:
  • 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:
  • OBP-20001: User not logged in. Authentication is required!
  • You must be able to see images in order to delete them
  • Image not found for this transaction
  • Deleting images not permitted for this view
  • Deleting images not permitted for the current user
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by deleteImageForViewOnTransaction, operation_id: OBPv1.2.1-deleteImageForViewOnTransaction

Delete comment

Delete the comment COMMENT_ID about the transaction TRANSACTION_ID made on view.

Authentication via OAuth is required. The user must either have owner privileges for this account, or must be the user that posted the comment.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by deleteCommentForViewOnTransaction, operation_id: OBPv1.2.1-deleteCommentForViewOnTransaction

Delete narrative

Deletes the description of the transaction TRANSACTION_ID.

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by deleteTransactionNarrative, operation_id: OBPv1.2.1-deleteTransactionNarrative

Delete where tag

Deletes the where tag of the transaction TRANSACTION_ID made on view.

Authentication is Mandatory

The user must either have owner privileges for this account, or must be the user that posted the geo tag.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "jsonString":"{}"
}
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:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • there is no tag to delete
  • Delete not completed
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by deleteWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-deleteWhereTagForViewOnTransaction

Get comments

Returns the transaction TRANSACTION_ID comments made on a view (VIEW_ID).

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

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "comments":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "value":"OBP",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by getCommentsForViewOnTransaction, operation_id: OBPv1.2.1-getCommentsForViewOnTransaction

Get images

Returns the transaction TRANSACTION_ID images made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "images":[{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "label":"NONE",
    "URL":"www.openbankproject.com",
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }]
}
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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by getImagesForViewOnTransaction, operation_id: OBPv1.2.1-getImagesForViewOnTransaction

Get narrative

Returns the account owner description of the transaction moderated by the view.

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

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "narrative":"narative"
}
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by getTransactionNarrative, operation_id: OBPv1.2.1-getTransactionNarrative

Get tags

Returns the transaction TRANSACTION_ID tags made on a view (VIEW_ID).
Authentication via OAuth is required if the view is not public.

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
  "value":"OBP",
  "date":"2017-09-19T00:00:00Z",
  "user":{
    "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
    "provider":"http://127.0.0.1:8080",
    "display_name":"OBP"
  }
}
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by getTagsForViewOnTransaction, operation_id: OBPv1.2.1-getTagsForViewOnTransaction

Get where tag

Returns the "where" Geo tag added to the transaction TRANSACTION_ID made on a view (VIEW_ID).
It represents the location where the transaction has been initiated.

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

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "where":{
    "latitude":1.231,
    "longitude":1.231,
    "date":"2017-09-19T00:00:00Z",
    "user":{
      "id":"5995d6a2-01b3-423c-a173-5481df49bdaf",
      "provider":"http://127.0.0.1:8080",
      "display_name":"OBP"
    }
  }
}
Possible Errors:
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by getWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-getWhereTagForViewOnTransaction

Update narrative

Updates the description of the transaction TRANSACTION_ID.

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

Authentication is Optional

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
Possible Errors:
  • OBP-10001: Incorrect json format.
  • 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:
  • OBP-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by updateTransactionNarrative, operation_id: OBPv1.2.1-updateTransactionNarrative

Update where tag

Updates the "where" Geo tag on a transaction TRANSACTION_ID in a view.

Authentication is Mandatory

The geo tag is linked with the user.

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{
  "success":"Success"
}
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-30005: View not found for Account. Please specify a valid value for VIEW_ID
  • OBP-30022: The current view does not have the permission:
  • Coordinates not possible
  • OBP-50000: Unknown Error.
Connector Methods:
Implemented in OBPv1.2.1 by updateWhereTagForViewOnTransaction, operation_id: OBPv1.2.1-updateWhereTagForViewOnTransaction