API Explorer
- Counterparty
-
Counterparty Metadata
- Add Corporate Location to Counterparty
- Add Counterparty More Info
- Add Open Corporates URL to Counterparty
- Add image url to other bank account
- Add physical location to other bank account
- Add public alias to other bank account
- Add url to other bank account
- Create Other Account Private Alias
- Delete Counterparty Corporate Location
- Delete Counterparty Image URL
- Delete Counterparty Open Corporates URL
- Delete Counterparty Physical Location
- Delete Counterparty Private Alias
- Delete Counterparty Public Alias
- Delete more info of other bank account
- Delete url of other bank account
- Get Other Account Metadata
- Get Other Account Private Alias
- Get public alias of other bank account
- Update Counterparty Corporate Location
- Update Counterparty Image Url
- Update Counterparty More Info
- Update Counterparty Physical Location
- Update Counterparty Private Alias
- Update Open Corporates Url of Counterparty
- Update public alias of other bank account
- Update url of other bank account
- Transaction Metadata
-
Counterparty
-
Counterparty Metadata
-
Add Corporate Location to Counterparty
-
Add Counterparty More Info
-
Add Open Corporates URL to Counterparty
-
Add image url to other bank account
-
Add physical location to other bank account
-
Add public alias to other bank account
-
Add url to other bank account
-
Create Other Account Private Alias
-
Delete Counterparty Corporate Location
-
Delete Counterparty Image URL
-
Delete Counterparty Open Corporates URL
-
Delete Counterparty Physical Location
-
Delete Counterparty Private Alias
-
Delete Counterparty Public Alias
-
Delete more info of other bank account
-
Delete url of other bank account
-
Get Other Account Metadata
-
Get Other Account Private Alias
-
Get public alias of other bank account
-
Update Counterparty Corporate Location
-
Update Counterparty Image Url
-
Update Counterparty More Info
-
Update Counterparty Physical Location
-
Update Counterparty Private Alias
-
Update Open Corporates Url of Counterparty
-
Update public alias of other bank account
-
Update url of other bank account
-
Add Corporate Location to Counterparty
-
Transaction Metadata
-
Add a tag
-
Add an image
-
Add comment
-
Add narrative
-
Add where tag
-
Delete a tag
-
Delete an image
-
Delete comment
-
Delete narrative
-
Delete where tag
-
Get comments
-
Get images
-
Get narrative
-
Get tags
-
Get where tag
-
Update narrative
-
Update where tag
-
Add a tag
v4.0.0 filtered by tag: Transaction-Metadata, Counterparty-Metadata (45 APIs)
Get Counterparty by Counterparty Id (Explicit)
Information returned about the Counterparty specified by COUNTERPARTY_ID:
Authentication is Mandatory
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:
-
counterparty_id: 9fg8a7e4-6d02-40e3-a129-0b2bf89de8uh
-
currency: EUR
-
date: 2020-01-27
-
is_beneficiary: true
-
key: CustomerNumber
-
latitude: 38.8951
-
longitude: -77.0364
-
username: felixsmith
-
value: 5987953
{
"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"
}
}
- 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.
Add Corporate Location to Counterparty
Add the geolocation of the counterparty's registered address
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
Add Open Corporates URL to Counterparty
Add open corporates url to other bank account
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
Add image url to other bank account
Add a url that points to the logo of the counterparty
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
Add physical location to other bank account
Add geocoordinates of the counterparty's main location
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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
Add url to other bank account
A url which represents the counterparty (home page url etc.)
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
Delete Counterparty Image URL
Delete image url of other bank account
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- OBP-50000: Unknown Error.
Delete Counterparty Open Corporates URL
Delete open corporate url of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
Delete Counterparty Physical Location
Delete physical location of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
Delete more info of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
Delete url of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"jsonString":"{}"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"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"
}
}
}
- OBP-20001: User not logged in. Authentication is required!
- OBP-50000: Unknown Error.
- the view does not allow metadata access
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"alias":"String"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"alias":"String"
}
- 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!
Update Counterparty Corporate Location
Update the geolocation of the counterparty's registered address
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
Update Counterparty Image Url
Update the url that points to the logo of the counterparty
Authentication is Optional
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
Update Counterparty Physical Location
Update geocoordinates of the counterparty's main location
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
Update Open Corporates Url of Counterparty
Update open corporate url of other bank account
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
Update url of other bank account
A url which represents the counterparty (home page url etc.)
Authentication is Mandatory
URL Parameters:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
VIEW_ID: owner
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
- value: 5987953
JSON response body fields:
{
"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"
}
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
-
label: My Account
JSON response body fields:
{
"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"
}
}
- 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!
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
- value: 5987953
JSON response body fields:
{
"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"
}
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
ACCOUNT_ID: 8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0
-
BANK_ID: gh.29.uk
-
TRANSACTION_ID: 2fg8a7e4-6d02-40e3-a129-0b2bf89de8ub
-
VIEW_ID: owner
JSON request body fields:
JSON response body fields:
{
"success":"Success"
}
- 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.
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:
-
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:
{
"jsonString":"{}"
}
- 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.
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:
-
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:
{
"jsonString":"{}"
}
- 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.
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:
-
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:
{
"jsonString":"{}"
}
- 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.
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:
-
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:
{
"jsonString":"{}"
}
- 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.
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:
-
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:
{
"jsonString":"{}"
}
- 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.
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:
-
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:
{
"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"
}
}]
}
- 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.
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:
-
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:
{
"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"
}
}]
}
- 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.
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:
-
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:
{
"narrative":"narative"
}
- 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.
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:
-
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:
{
"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"
}
}
- 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.
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:
-
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:
{
"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"
}
}
}
- 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.
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:
-
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:
{
"success":"Success"
}
- 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.
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:
-
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:
{
"success":"Success"
}
- 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.